Laravel Cashier

• Einführung
• Upgrade Kassierer
• Konfiguration
  • Streifen
  • BH intree
  • Währungskonfiguration
• Abonnieren
  • Abonnement erstellen
  • Abonnementstatus prüfen
  • Abonnementplan ändern
  • Abonnement Betrag
  • Abonnementsteuer
  • Ankerdatum des Abonnements
  • Abonnement kündigen
  • Abonnement wiederherstellen
• Probeabonnement
  • Mit Kreditkarte abonnieren
  • Abonnements ohne Kreditkarte
• Kunde
  • Kunde erstellen
• Bankkarte
  • Kreditkarte erhalten
  • Kartennummer bestätigen. Datei
  • Kreditkarte aktualisieren
  • Kreditkarte löschen
• Prozess Stripe-Webhooks
  • Webhook-Ereignisse definieren
  • Abonnement fehlgeschlagen
  • Webhook Verifizierung
• Verarbeitung von Braintree-Webhooks
  • Definition Webhook Veranstaltung
  • Abonnement fehlgeschlagen
• Einmalige Gebühr
  • Einfach aufladen
  • Rechnung aufladen
  • Rückerstattungsbearbeitung
• Rechnung
  • Generieren PDF-Rechnung

Einführung

Laravel Cashier bietet eine intuitive und reibungslose Benutzeroberfläche für den Zugriff auf die kostenpflichtigen Abonnementdienste von Stripe's und Braintree's. Es kann mit kostenpflichtigen Abonnementcodes umgehen, die einem fast Kopfschmerzen bereiten. Cashier bietet nicht nur eine grundlegende Abonnementverwaltung, sondern kann Ihnen auch bei Gutscheinen, dem Umtausch von Abonnements, Abonnementmengen, Kündigungsfristen und sogar der Erstellung von PDF-Rechnungen behilflich sein.

{Hinweis} Sie sollten Cashier nicht verwenden, wenn Sie nur eine „einmalige“ Gebühr benötigen und kein Abonnement anbieten. Es wird empfohlen, die Stripe- und Braintree-SDKs zu verwenden.

Upgrade von Cashier

Wenn Sie von einer alten Version auf die neueste Version von Cashier aktualisieren, wird dies durchgeführt Es wird empfohlen, dass Sie zuerst lesenKassierer Upgrade-Anleitung.

Konfiguration

Stripe

Komponist

Zuerst hinzufügen Fügen Sie das Cashier-Paket von Stripe zu Ihren Projektabhängigkeiten hinzu:

composer require laravel/cashier

Datenbankmigration

Bevor Sie Cashier verwenden, müssen Sie die Datenbank vorbereiten. Der Kassierer muss Ihrer users-Tabelle einige Spalten hinzufügen und eine neue subscriptions-Tabelle erstellen, um die Abonnements aller Kunden zu speichern:

Schema::table('users', function ($table) {
    $table->string('stripe_id')->nullable()->collation('utf8mb4_bin');    
    $table->string('card_brand')->nullable();    
    $table->string('card_last_four', 4)->nullable();    
    $table->timestamp('trial_ends_at')->nullable();
   });
Schema::create('subscriptions', function ($table) { 
   $table->increments('id');    
   $table->unsignedInteger('user_id');    
   $table->string('name');    
   $table->string('stripe_id')->collation('utf8mb4_bin');    
   $table->string('stripe_plan');    
   $table->integer('quantity');    
   $table->timestamp('trial_ends_at')->nullable();    
   $table->timestamp('ends_at')->nullable();    
   $table->timestamps();
 });

Sobald die Migrationsdatei eingerichtet ist, führen Sie den migrate-Befehl von Artisan aus .

Abrechenbares Modell

Fügen Sie als Nächstes das Merkmal Billable zu Ihrer Modelldefinition hinzu. Diese Eigenschaft bietet mehrere Methoden zum Ausführen allgemeiner Zahlungsaufgaben, wie zum Beispiel das Erstellen von Abonnements, die Verwendung von Gutscheinen und das Aktualisieren von Kreditkarteninformationen:

use Laravel\Cashier\Billable;class User extends Authenticatable{
    use Billable;
  }

API-Schlüssel

Schließlich im Konfiguration Konfigurieren Sie den Stripe-Schlüssel in der Datei services.php Sie können diese Stripe-API-Schlüssel im persönlichen Control Panel der offiziellen Website von Stripe erhalten. Infos:

'stripe' => [
    'model'  => App\User::class,    
    'key' => env('STRIPE_KEY'),    
    'secret' => env('STRIPE_SECRET'),
  ],

Braintree

Braintree-Hinweise

In vielen Fällen implementieren Stripe und Braintree die Kassenfunktionen auf die gleiche Weise. Beide bieten die Funktion der Abonnementzahlung per Kreditkarte, und Braintree unterstützt zusätzlich die Zahlung über PayPal. Allerdings fehlen Braintree auch einige Funktionen, die Stripe unterstützt. Bevor Sie sich für die Verwendung von Stripe oder Braintree entscheiden, müssen Sie die folgenden Punkte berücksichtigen:

Komponist

Fügen Sie zunächst das Cashier-Paket von Braintree zu den Abhängigkeiten Ihres Projekts hinzu:

composer require "laravel/cashier-braintree":"~2.0"

Credit Kartenrabattplan

Mit der Kasse Zuvor müssen Sie im Braintree-Kontrollpanel zunächst einen plan-credit-Rabatt definieren. Dieser Rabatt entspricht dem entsprechenden Rabattverhältnis basierend auf der vom Benutzer gewählten Zahlungsoption, z. B. jährlicher Zahlung oder monatlicher Zahlung.

Der im Braintree-Kontrollfeld konfigurierte Gesamtrabattbetrag kann nach Wunsch eingegeben werden, und der Kassierer überschreibt bei jeder Verwendung eines Gutscheins den Standardwert gemäß Ihrer Konfiguration. Dieser Coupon ist erforderlich, da Braintree die Verwendung der Abonnementhäufigkeit zur Anpassung an Rabattverhältnisse nicht unterstützt.

Datenbankmigration

Bevor Sie Cashier verwenden, müssen Sie die Datenbank vorbereiten. Der Kassierer muss Ihrer Datenbank-users-Tabelle einige neue Spalten hinzufügen und eine neue subscriptions-Tabelle erstellen, um Kundenabonnementinformationen zu speichern:

Schema::table('users', function ($table) { 
   $table->string('braintree_id')->nullable();    
   $table->string('paypal_email')->nullable();    
   $table->string('card_brand')->nullable();    
   $table->string('card_last_four')->nullable();    
   $table->timestamp('trial_ends_at')->nullable();
   });
Schema::create('subscriptions', function ($table) {
    $table->increments('id');    
    $table->unsignedInteger('user_id');    
    $table->string('name');    
    $table->string('braintree_id');    
    $table->string('braintree_plan');    
    $table->integer('quantity');    
    $table->timestamp('trial_ends_at')->nullable();    
    $table->timestamp('ends_at')->nullable();    
    $table->timestamps();
   });

Sobald die Migrationsdatei erstellt ist, führen Sie den migrate-Befehl von Artisan aus.

Abrechenbares Modell

Dann fügen Sie das Billable Merkmal zu Ihrer Modelldefinition hinzu:

use Laravel\Cashier\Billable;
class User extends Authenticatable{ 
   use Billable;
  }

API-Schlüssel

Als nächstes sollten Sie bei services.php sein Konfigurieren Sie die folgenden Optionen in der Datei:

'braintree' => [
    'model'  => App\User::class,    
    'environment' => env('BRAINTREE_ENV'),    
    'merchant_id' => env('BRAINTREE_MERCHANT_ID'),    
    'public_key' => env('BRAINTREE_PUBLIC_KEY'),    
    'private_key' => env('BRAINTREE_PRIVATE_KEY'),
  ],

Abschließend müssen Sie das folgende Braintree SDK zur AppServiceProvider-Methode des bootDienstanbieters hinzufügen Rufen Sie an:

\Braintree_Configuration::environment(config('services.braintree.environment'));
\Braintree_Configuration::merchantId(config('services.braintree.merchant_id'));
\Braintree_Configuration::publicKey(config('services.braintree.public_key'));
\Braintree_Configuration::privateKey(config('services.braintree.private_key'));

Währungskonfiguration

Kassierer verwendet US-Dollar (USD) als Standardwährung. Sie können die Standardwährung ändern, indem Sie die Methode boot in der Methode Cashier::useCurrency des Dienstanbieters aufrufen. Diese useCurrency-Methode akzeptiert zwei Zeichenfolgenparameter: Währung und Währungssymbol:

use Laravel\Cashier\Cashier;
Cashier::useCurrency('eur', '€');

Subscribe

Erstellen Sie ein Abonnement

Um ein Abonnement zu erstellen, müssen Sie zunächst eine kostenpflichtige Modellinstanz erhalten, bei der es sich normalerweise um eine Instanz von AppUser handelt. Sobald Sie die Modellinstanz erhalten haben, können Sie mit der Methode newSubscription ein Abonnement für das Modell erstellen:

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

newSubscription Das erste Argument der Methode sollte der Name des Abonnements sein. Wenn Ihre Anwendung nur ein Abonnement anbietet, können Sie es auf main oder primary einstellen. Der zweite Parameter ist der Stripe/Braintree-Plan, den der Benutzer abonniert hat. Dieser Wert sollte einem Bezeichner in Stripe oder Braintree entsprechen. Die Methode

create akzeptiert eine Stripe-Kreditkarte/einen Quell-Token, der das Abonnement startet und die Datenbank mit der Kunden-ID und anderen relevanten Rechnungsinformationen aktualisiert.

Zusätzliche Details des Benutzers

Wenn Sie zusätzliche Details des Benutzers angeben möchten, können Sie dies tun, indem Sie diese als zweiten Parameter an create übergeben Methode:

$user->newSubscription('main', 'monthly')->create($stripeToken, [
    'email' => $email,
   ]);

Um mehr über Stripe oder die zusätzlichen von Braintree unterstützten Felder zu erfahren, schauen Sie sich Stripe an Content Creation Customer Documentation oder die entsprechende Braintree Documentation.

Gutschein

Wenn Sie beim Erstellen Ihres Abonnements einen Gutschein verwenden möchten, können Sie withCoupon verwenden Methoden:

$user->newSubscription('main', 'monthly')  
   ->withCoupon('code')     
   ->create($stripeToken);

Abonnementstatus prüfen

Sobald sich der Benutzer in Ihrer App angemeldet hat, können Sie jedes A verwenden bequeme Möglichkeit, den Abonnementstatus einfach zu überprüfen. Erstens: Wenn der Benutzer ein aktives Abonnement hat, gibt die subscribed-Methode true zurück, auch wenn sich das Abonnement derzeit in der Testphase befindet:

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

Diese subscribed-Methode kann auch beim Routing verwendet werden Middleware, die Ihnen Zugriff auf Routen und Controller basierend auf dem Abonnementstatus des Benutzers ermöglicht:

public function handle($request, Closure $next){
    if ($request->user() && ! $request->user()->subscribed('main')) {
      // This user is not a paying customer...        
      return redirect('billing');   
     }    
    return $next($request);
 }

Wenn Sie feststellen möchten, ob sich der Benutzer noch in der Testversion befindet, können Sie diese verwenden onTrial Methode. Diese Methode ist nützlich, um dem Benutzer eine Warnung anzuzeigen, dass er sich noch im Testzeitraum befindet:

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

Basierend auf einer bestimmten Stripe-/Braintree-Plan-ID kann die subscribedToPlan-Methode verwendet werden, um festzustellen, ob der Benutzer hat den Plan abonniert. In diesem Beispiel ermitteln wir, ob das main-Abonnement des Benutzers einen aktiven monthly-Plan hat: Die Methode

if ($user->subscribedToPlan('monthly', 'main')) {
    //
   }

recurring kann verwendet werden, um festzustellen, ob der Benutzer derzeit abonniert ist und nicht mehr dabei ist die Probephase:

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

Abmeldestatus

Um festzustellen, ob ein Benutzer einmal ein Abonnement hatte, sein Abonnement aber gekündigt hat, können Sie die cancelled-Methode verwenden:

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

Sie können auch feststellen, ob der Benutzer ein Abonnement hat Das Abonnement wurde gekündigt, befindet sich jedoch noch in der „Nachfrist“ des Abonnements, bis das Abonnement vollständig abläuft. Wenn ein Benutzer beispielsweise am 5. März ein Abonnement kündigt, das am 10. März ablaufen sollte, hat der Benutzer eine „Kulanzfrist“ bis zum 10. März. Beachten Sie, dass die subscribed-Methode während dieser Zeit immer noch true zurückgibt:

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

Wenn Sie feststellen möchten, ob der Zeitpunkt, zu dem sich der Benutzer abgemeldet hat, nicht mehr innerhalb seiner „Nachfrist“ liegt, können Sie ended verwenden Methode:

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

Abonnementplan ändern

Nachdem Benutzer Ihre App abonniert haben, möchten sie möglicherweise gelegentlich zu wechseln ein neues Abonnement. Um einen Benutzer zu einem neuen Abonnement zu wechseln, übergeben Sie die Abonnementplan-ID an die swap-Methode:

$user = App\User::find(1);
$user->subscription('main')->swap('provider-plan-id');

Wenn sich der Benutzer in einem Testzeitraum befindet, bleibt die Dauer des Testzeitraums erhalten. Wenn darüber hinaus ein „Anteil“ für die Anzahl der Abonnements besteht, wird dieser Anteil auch beibehalten.

Wenn Sie den Testzeitraum des aktuellen Abonnements des Benutzers kündigen möchten, wenn Sie den Abonnementplan des Benutzers ändern, können Sie die skipTrial-Methode verwenden:

$user->subscription('main')    
    ->skipTrial()        
    ->swap('provider-plan-id');

Abonnements

{Hinweis} Abonnements werden nur über Cashier's Stripe abgewickelt. Braintree verfügt nicht über eine „Mengen“-Funktion, die Stripe entspricht.

Manchmal werden Abonnements von der „Menge“ beeinflusst. Die Kosten für Ihre App könnten beispielsweise 10 $/Monat pro Konto betragen. Sie können Ihr Abonnement ganz einfach mit den Methoden und incrementQuantity erhöhen oder verringern: decrementQuantity

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

einen bestimmten Betrag festlegen: updateQuantity

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

Die Methode kann verwendet werden, um die Abonnementmenge zu aktualisieren, ohne die Gebühr zu berechnen: noProrate

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

Stripe Dokument.

-Methode im Abrechnungsmodus und gibt eine A-Nummer zurück von 0 bis 100, nicht mehr als 2 Eine Dezimalzahl, die den Steuerprozentsatz angibt, den Benutzer für ihr Abonnement zahlen. Mit der taxPercentage

public function taxPercentage() {
    return 20;
   }

-Methode können Sie Steuersätze auf Modellbasis anwenden, was für eine Benutzerbasis hilfreich sein kann, die mehrere Länder und Steuersätze umfasst. taxPercentage

{Hinweis}

Diese Methode gilt nur für das kostenpflichtige Abonnementmodell. Wenn Sie Gebühren verwenden, um „einmalige“ Gebühren zu erheben, müssen Sie gleichzeitig den Steuersatz manuell angeben. taxPercentage

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

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

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

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

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

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

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

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

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

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

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

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

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

$user->createAsStripeCustomer();

$cards = $user->cards();

$card = $user->defaultCard();

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

$user->updateCard($stripeToken);

$user->updateCardFromStripe();

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

$user->deleteCards();

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

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

<?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)  
        {     
           // 此处处理事件   
         }
      }

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

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

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

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

<?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)  
        {    
            // 此处处理时事件... 
         }
     }

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

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

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

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

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

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

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

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

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

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

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