サブスクリプション対応決済サービス Stripe と Laravel からサブスクリプションを操作する Laravel Cashier についてのメモ書き

Laravel Cashierで実装されている機能(メソッド)一覧

Laravel Cashier( Billable トレイト )( SubscriptionBuilder )で実装されている機能はどういったものがあるでしょうか?

ファイルから public function を抜き出してみます。

● Laravel Cashier( Billable トレイト)のメソッド一覧

URL: https://github.com/laravel/cashier/blob/822b6535e755fd36dec8ecceb52cc8909c8a953e/src/Billable.php

・ customer関連

// ユーザーが既に Stripe Customer になっているかどうか判定する
//  @return bool
public function hasStripeId()
// ユーザーをStripe Customer として登録する
//  @return \Stripe\Customer
public function createAsStripeCustomer(array $options = [])
// ユーザーのStripe Customer 情報を更新する
//  @return \Stripe\Customer
public function updateStripeCustomer(array $options = [])
// ユーザーのStripe Customer 情報を取得して返す
// @return \Stripe\Customer
public function asStripeCustomer()

・ インボイス関連

// インボイス付き課金 を実行する
//  @return \Stripe\Invoice|bool
public function invoiceFor($description, $amount, array $tabOptions = [], array $invoiceOptions = [])


public function invoice(array $options = [])
public function upcomingInvoice()
public function findInvoice($id)
public function findInvoiceOrFail($id)
public function downloadInvoice($id, array $data)
public function invoices($includePending = false, $parameters = [])
public function invoicesIncludingPending(array $parameters = [])

・ その他

public function charge($amount, array $options = [])
public function refund($charge, array $options = [])
public function hasCardOnFile()
public function tab($description, $amount, array $options = [])
public function newSubscription($subscription, $plan)

// 現在サブスクリプションがトライアル中かどうかを判別する
public function onTrial($subscription = 'default', $plan = null)

// あるユーザーのサブスクリプションを全て取得
public function subscriptions()

// あるユーザーのサブスクリプションを「名前から」取得
public function subscription($subscription = 'default')


public function onGenericTrial()
public function subscribed($subscription = 'default', $plan = null)
public function cards($parameters = [])
public function defaultCard()
public function updateCard($token)
public function updateCardFromStripe()
public function deleteCards()
public function applyCoupon($coupon)
public function subscribedToPlan($plans, $subscription = 'default')
public function onPlan($plan)
public function preferredCurrency()
public function taxPercentage()

● Laravel Cashier( SubscriptionBuilder )のメソッド一覧

URL: https://github.com/laravel/cashier/blob/822b6535e755fd36dec8ecceb52cc8909c8a953e/src/SubscriptionBuilder.php

public function __construct($owner, $name, $plan)
public function quantity($quantity)
public function trialDays($trialDays)
public function trialUntil(Carbon $trialUntil)
public function skipTrial()
public function anchorBillingCycleOn($date)
public function withCoupon($coupon)

// サブスクリプション作成時にメタデータをセットする(インボイス全体のmetadataではなく、インボイスアイテムのmetadataに格納されます)
public function withMetadata($metadata)

public function add(array $options = [])
public function create($token = null, array $options = [])

関連エントリー

No.1500
05/07 15:33

edit

LaravelCashier