Laravel Cashier (Stripe)

• 소개
• Cashier 업그레이드
• 설치
• 구성
  • 빌링 가능 모델
  • API 키
  • 통화 구성
  • 세금 구성
  • 로깅
  • 사용자 정의 모델 사용
• 빠른 시작
  • 제품 판매
  • 구독 판매
• 고객
  • 고객 검색
  • 고객 생성
  • 고객 업데이트
  • 잔액
  • 세금 ID
  • Stripe와 고객 데이터 동기화
  • 결제 포털
• 결제 수단
  • 결제 수단 저장
  • 결제 수단 검색
  • 결제 수단 존재 여부
  • 기본 결제 수단 업데이트
  • 결제 수단 추가
  • 결제 수단 삭제
• 구독
  • 구독 생성
  • 구독 상태 확인
  • 가격 변경
  • 구독 수량
  • 여러 제품이 있는 구독
  • 여러 구독
  • 사용량 기반 청구
  • 구독 세금
  • 구독 기준일
  • 구독 취소
  • 구독 재개
• 구독 평가판
  • 결제 수단을 선불로 사용하는 경우
  • 결제 수단을 선불로 사용하지 않는 경우
  • 평가판 연장
• Stripe 웹훅 처리
  • 웹훅 이벤트 핸들러 정의
  • 웹훅 서명 확인
• 단일 결제
  • 단순 결제
  • 청구서 포함 결제
  • 결제 인텐트 생성
  • 결제 환불
• 결제
  • 제품 결제
  • 단일 결제 결제
  • 구독 결제
  • 세금 ID 수집
  • 게스트 결제
• 청구서
  • 청구서 검색
  • 예정된 청구서
  • 구독 청구서 미리보기
  • 청구서 PDF 생성
• 결제 실패 처리
  • 결제 확인
• 강력한 고객 인증 (SCA)
  • 추가 확인이 필요한 결제
  • 오프 세션 결제 알림
• Stripe SDK
• 테스트

소개

Laravel Cashier Stripe는 Stripe의 구독 청구 서비스에 대한 표현력이 풍부하고 유창한 인터페이스를 제공합니다. 이 라이브러리는 작성하기 두려워하는 대부분의 상용구 구독 청구 코드를 처리합니다. 기본적인 구독 관리 외에도 Cashier는 쿠폰, 구독 스와핑, 구독 "수량", 취소 유예 기간을 처리하고 청구서 PDF를 생성할 수도 있습니다.

Cashier 업그레이드

새로운 버전의 Cashier로 업그레이드할 때는 업그레이드 가이드를 주의 깊게 검토해야 합니다.

설치

먼저 Composer 패키지 관리자를 사용하여 Stripe용 Cashier 패키지를 설치합니다.

composer require laravel/cashier

패키지를 설치한 후, vendor:publish Artisan 명령어를 사용하여 Cashier의 마이그레이션을 게시합니다:

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

그런 다음, 데이터베이스를 마이그레이션합니다:

php artisan migrate

Cashier의 마이그레이션은 users 테이블에 여러 열을 추가합니다. 또한 모든 고객의 구독을 보관하는 새로운 subscriptions 테이블과 여러 가격이 있는 구독을 위한 subscription_items 테이블을 생성합니다.

원하는 경우, vendor:publish Artisan 명령어를 사용하여 Cashier의 구성 파일도 게시할 수 있습니다:

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

마지막으로, Cashier가 모든 Stripe 이벤트를 올바르게 처리하도록 하려면 Cashier의 웹훅 처리 구성을 기억하십시오.

구성

청구 가능 모델

Cashier를 사용하기 전에 청구 가능 모델 정의에 Billable 트레이트를 추가하십시오. 일반적으로 이것은 App\Models\User 모델일 것입니다. 이 트레이트는 구독 생성, 쿠폰 적용, 결제 수단 정보 업데이트와 같은 일반적인 청구 작업을 수행할 수 있는 다양한 방법을 제공합니다.

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

Cashier는 청구 가능 모델이 Laravel과 함께 제공되는 App\Models\User 클래스라고 가정합니다. 이를 변경하고 싶다면 useCustomerModel 메소드를 통해 다른 모델을 지정할 수 있습니다. 이 메서드는 일반적으로 AppServiceProvider 클래스의 boot 메서드에서 호출해야 합니다.

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

API 키

다음으로, 애플리케이션의 .env 파일에서 Stripe API 키를 구성해야 합니다. Stripe API 키는 Stripe 제어판에서 검색할 수 있습니다.

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

통화 구성

Cashier의 기본 통화는 미국 달러(USD)입니다. 애플리케이션의 .env 파일 내에서 CASHIER_CURRENCY 환경 변수를 설정하여 기본 통화를 변경할 수 있습니다:

CASHIER_CURRENCY=eur

Cashier의 통화를 구성하는 것 외에도 청구서에 표시하기 위해 금액 값을 포맷할 때 사용할 로케일을 지정할 수도 있습니다. 내부적으로 Cashier는 PHP의 NumberFormatter 클래스를 활용하여 통화 로케일을 설정합니다:

CASHIER_CURRENCY_LOCALE=nl_BE

세금 구성

Stripe Tax 덕분에 Stripe에서 생성된 모든 송장에 대한 세금을 자동으로 계산할 수 있습니다. 애플리케이션의 App\Providers\AppServiceProvider 클래스의 boot 메서드에서 calculateTaxes 메서드를 호출하여 자동 세금 계산을 활성화할 수 있습니다.

use Laravel\Cashier\Cashier;
 
/**
 * 모든 애플리케이션 서비스 부트스트랩.
 */
public function boot(): void
{
    Cashier::calculateTaxes();
}

세금 계산이 활성화되면 생성되는 모든 새 구독 및 일회성 송장에 자동 세금 계산이 적용됩니다.

이 기능이 제대로 작동하려면 고객 이름, 주소 및 세금 ID와 같은 고객 청구 정보가 Stripe와 동기화되어야 합니다. Cashier에서 제공하는 고객 데이터 동기화 및 세금 ID 메서드를 사용하여 이를 수행할 수 있습니다.

로깅

Cashier를 사용하면 치명적인 Stripe 오류를 로깅할 때 사용할 로그 채널을 지정할 수 있습니다. 애플리케이션의 .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 메서드에서 Cashier에 사용자 정의 모델에 대해 알려야 합니다.

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 
/**
 * 모든 애플리케이션 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);
}

빠른 시작

제품 판매

애플리케이션을 통해 제품 및 구독 청구를 제공하는 것은 어려울 수 있습니다. 하지만 Cashier와 Stripe Checkout 덕분에 현대적이고 강력한 결제 통합을 쉽게 구축할 수 있습니다.

비정기적이고 단일 청구 제품에 대해 고객에게 청구하려면 Cashier를 사용하여 고객을 Stripe Checkout으로 안내하고, 여기에서 결제 세부 정보를 제공하고 구매를 확인합니다. Checkout을 통해 결제가 완료되면 고객은 애플리케이션 내에서 선택한 성공 URL로 리디렉션됩니다.

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 고객 레코드를 애플리케이션 데이터베이스의 해당 사용자와 연결합니다. Checkout 세션이 완료되면 고객은 고객에게 정보 메시지를 표시할 수 있는 전용 성공 또는 취소 페이지로 리디렉션됩니다.

Stripe Checkout에 메타데이터 제공

제품을 판매할 때 애플리케이션에서 정의한 Cart 및 Order 모델을 통해 완료된 주문 및 구매한 제품을 추적하는 것이 일반적입니다. 고객이 구매를 완료하기 위해 Stripe Checkout으로 리디렉션될 때, 고객이 애플리케이션으로 다시 리디렉션될 때 완료된 구매를 해당 주문과 연결할 수 있도록 기존 주문 식별자를 제공해야 할 수 있습니다.

이를 위해 checkout 메서드에 metadata 배열을 제공할 수 있습니다. 사용자가 결제 프로세스를 시작할 때 애플리케이션 내에서 보류 중인 Order가 생성된다고 가정해 보겠습니다. 이 예에서 Cart 및 Order 모델은 예시이며 Cashier에서 제공하지 않는다는 점을 기억하십시오. 자신의 애플리케이션 요구 사항에 따라 자유롭게 이러한 개념을 구현할 수 있습니다.

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 템플릿 변수를 Checkout 성공 경로에 추가했습니다. Stripe가 고객을 애플리케이션으로 다시 리디렉션할 때 이 템플릿 변수는 자동으로 Checkout 세션 ID로 채워집니다.

다음으로 Checkout 성공 경로를 만들어 보겠습니다. 이는 Stripe Checkout을 통해 구매가 완료된 후 사용자가 리디렉션되는 경로입니다. 이 경로 내에서 제공된 메타데이터에 액세스하고 고객의 주문을 업데이트하기 위해 Stripe Checkout 세션 ID와 연결된 Stripe Checkout 인스턴스를 검색할 수 있습니다.

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

Checkout 세션 객체에 포함된 데이터에 대한 자세한 내용은 Stripe 설명서를 참조하십시오.

구독 판매

애플리케이션을 통해 제품 및 구독 청구를 제공하는 것은 어려울 수 있습니다. 하지만 Cashier와 Stripe Checkout 덕분에 현대적이고 강력한 결제 통합을 쉽게 구축할 수 있습니다.

Cashier와 Stripe Checkout을 사용하여 구독을 판매하는 방법을 배우기 위해 월별 기본(price_basic_monthly) 및 연간(price_basic_yearly) 요금제를 갖춘 구독 서비스의 간단한 시나리오를 고려해 보겠습니다. 이러한 두 가격은 Stripe 대시보드에서 "기본" 제품(pro_basic)으로 그룹화될 수 있습니다. 또한 구독 서비스는 전문가 요금제를 pro_expert로 제공할 수 있습니다.

먼저 고객이 서비스에 가입하는 방법을 알아보겠습니다. 물론 고객이 애플리케이션 가격 책정 페이지에서 기본 요금제의 "구독" 버튼을 클릭할 수 있다고 상상할 수 있습니다. 이 버튼이나 링크는 사용자를 선택한 요금제에 대한 Stripe Checkout 세션을 만드는 Laravel 경로로 안내해야 합니다.

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 세션으로 리디렉션합니다. Checkout 성공 또는 취소 후 고객은 checkout 메서드에 제공한 URL로 다시 리디렉션됩니다. 구독이 실제로 시작된 시점을 알기 위해(일부 결제 방법은 처리하는 데 몇 초가 걸리므로) Cashier의 웹훅 처리 구성도 필요합니다.

이제 고객이 구독을 시작할 수 있으므로 구독한 사용자만 액세스할 수 있도록 애플리케이션의 특정 부분을 제한해야 합니다. 물론, Cashier의 Billable 트레이트에서 제공하는 subscribed 메서드를 통해 사용자의 현재 구독 상태를 항상 확인할 수 있습니다.

@if ($user->subscribed())
    <p>구독 중입니다.</p>
@endif

사용자가 특정 제품 또는 가격을 구독하고 있는지 여부도 쉽게 확인할 수 있습니다:

@if ($user->subscribedToProduct('pro_basic'))
    <p>베이직 제품을 구독 중입니다.</p>
@endif
 
@if ($user->subscribedToPrice('price_basic_monthly'))
    <p>월간 베이직 요금제를 구독 중입니다.</p>
@endif

구독된 미들웨어 구축

편의를 위해, 들어오는 요청이 구독된 사용자로부터 온 것인지 확인하는 미들웨어를 생성하는 것이 좋습니다. 이 미들웨어가 정의되면 구독하지 않은 사용자가 경로에 접근하는 것을 막기 위해 경로에 쉽게 할당할 수 있습니다.

<?php
 
namespace App\Http\Middleware;
 
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
 
class Subscribed
{
    /**
     * 들어오는 요청 처리.
     */
    public function handle(Request $request, Closure $next): Response
    {
        if (! $request->user()?->subscribed()) {
            // 사용자를 청구 페이지로 리디렉션하고 구독을 요청합니다...
            return redirect('/billing');
        }
 
        return $next($request);
    }
}

미들웨어가 정의되면 경로에 할당할 수 있습니다.

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

고객이 청구 플랜을 관리하도록 허용

물론 고객은 구독 플랜을 다른 제품 또는 "티어"로 변경하고 싶을 수 있습니다. 이를 허용하는 가장 쉬운 방법은 고객을 Stripe의 Customer Billing Portal로 안내하는 것입니다. 이 포털은 고객이 송장을 다운로드하고, 결제 방법을 업데이트하고, 구독 플랜을 변경할 수 있는 호스팅된 사용자 인터페이스를 제공합니다.

먼저, 애플리케이션 내에서 사용자를 Billing Portal 세션을 시작하는 데 사용할 Laravel 경로로 안내하는 링크 또는 버튼을 정의합니다.

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

다음으로, Stripe 고객 결제 포털 세션을 시작하고 사용자를 포털로 리디렉션하는 경로를 정의해 보겠습니다. redirectToBillingPortal 메서드는 사용자가 포털에서 나갈 때 돌아가야 하는 URL을 허용합니다.

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

고객

고객 검색

Cashier::findBillable 메서드를 사용하여 Stripe ID로 고객을 검색할 수 있습니다. 이 메서드는 청구 가능한 모델의 인스턴스를 반환합니다.

use Laravel\Cashier\Cashier;
 
$user = Cashier::findBillable($stripeId);

고객 생성

때로는 구독을 시작하지 않고 Stripe 고객을 생성하고 싶을 수 있습니다. createAsStripeCustomer 메서드를 사용하여 이를 수행할 수 있습니다.

$stripeCustomer = $user->createAsStripeCustomer();

Stripe에서 고객이 생성되면 나중에 구독을 시작할 수 있습니다. 추가적인 Stripe API에서 지원하는 고객 생성 매개변수를 전달하기 위해 선택적 $options 배열을 제공할 수 있습니다.

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

청구 가능 모델에 대한 Stripe 고객 객체를 반환하고 싶으면 asStripeCustomer 메서드를 사용할 수 있습니다.

$stripeCustomer = $user->asStripeCustomer();

특정 청구 가능 모델에 대한 Stripe 고객 객체를 검색하고 싶지만 청구 가능 모델이 이미 Stripe 내에 고객인지 확실하지 않은 경우 createOrGetStripeCustomer 메서드를 사용할 수 있습니다. 이 메서드는 아직 존재하지 않는 경우 Stripe에서 새 고객을 만듭니다.

$stripeCustomer = $user->createOrGetStripeCustomer();

고객 업데이트

때로는 추가 정보를 사용하여 Stripe 고객을 직접 업데이트하고 싶을 수 있습니다. updateStripeCustomer 메서드를 사용하여 이를 수행할 수 있습니다. 이 메서드는 Stripe API에서 지원하는 고객 업데이트 옵션 배열을 허용합니다.

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

잔액

Stripe를 사용하면 고객의 "잔액"을 입금하거나 출금할 수 있습니다. 나중에 이 잔액은 새로운 송장에서 입금되거나 출금됩니다. 고객의 총 잔액을 확인하려면 청구 가능 모델에서 사용할 수 있는 balance 메서드를 사용할 수 있습니다. balance 메서드는 고객의 통화로 형식이 지정된 잔액 문자열 표현을 반환합니다.

$balance = $user->balance();

고객의 잔액을 입금하려면 creditBalance 메서드에 값을 제공할 수 있습니다. 원하는 경우 설명을 제공할 수도 있습니다.

$user->creditBalance(500, '프리미엄 고객 충전.');

debitBalance 메서드에 값을 제공하면 고객의 잔액이 출금됩니다.

$user->debitBalance(300, '잘못된 사용 페널티.');

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 웹훅 이벤트를 구독하고 VAT ID의 verification 매개변수를 검사하여 확인 업데이트 알림을 받을 수 있습니다. 웹훅 처리 방법에 대한 자세한 내용은 웹훅 핸들러 정의에 대한 설명서를 참조하십시오.

deleteTaxId 메서드를 사용하여 세금 ID를 삭제할 수 있습니다.

$user->deleteTaxId('txi_belgium');

Stripe와 고객 데이터 동기화

일반적으로 애플리케이션 사용자가 이름, 이메일 주소 또는 Stripe에도 저장된 기타 정보를 업데이트하는 경우 Stripe에 업데이트 내용을 알려야 합니다. 그렇게 하면 정보에 대한 Stripe의 복사본이 애플리케이션과 동기화됩니다.

이를 자동화하려면 모델의 updated 이벤트에 반응하는 청구 가능 모델에 이벤트 리스너를 정의할 수 있습니다. 그런 다음 이벤트 리스너 내에서 모델에서 syncStripeCustomerDetails 메서드를 호출할 수 있습니다.

use App\Models\User;
use function Illuminate\Events\queueable;
 
/**
 * 모델의 "booted" 메서드입니다.
 */
protected static function booted(): void
{
    static::updated(queueable(function (User $customer) {
        if ($customer->hasStripeId()) {
            $customer->syncStripeCustomerDetails();
        }
    }));
}

이제 고객 모델이 업데이트될 때마다 해당 정보가 Stripe와 동기화됩니다. 편의를 위해 Cashier는 고객을 처음 생성할 때 고객 정보를 Stripe와 자동으로 동기화합니다.

Cashier에서 제공하는 다양한 메서드를 재정의하여 Stripe에 고객 정보를 동기화하는 데 사용되는 열을 사용자 지정할 수 있습니다. 예를 들어, Cashier가 고객 정보를 Stripe와 동기화할 때 고객의 "이름"으로 간주해야 하는 속성을 사용자 지정하기 위해 stripeName 메서드를 재정의할 수 있습니다.

/**
 * Stripe와 동기화해야 하는 고객 이름을 가져옵니다.
 */
public function stripeName(): string|null
{
    return $this->company_name;
}

마찬가지로 stripeEmail, stripePhone, stripeAddress 및 stripePreferredLocales 메서드를 재정의할 수 있습니다. 이러한 메서드는 Stripe 고객 객체를 업데이트할 때 해당 고객 매개변수에 정보를 동기화합니다. 고객 정보 동기화 프로세스를 완전히 제어하려면 syncStripeCustomerDetails 메서드를 재정의할 수 있습니다.

결제 포털

Stripe는 고객이 구독, 결제 방법 및 결제 내역을 관리할 수 있도록 결제 포털을 설정하는 쉬운 방법을 제공합니다. 컨트롤러 또는 경로에서 청구 가능 모델에서 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 트레이트는 새 Setup Intent를 쉽게 생성하는 createSetupIntent 메서드를 포함합니다. 고객의 결제 방법 세부 정보를 수집하는 양식을 렌더링할 경로 또는 컨트롤러에서 이 메서드를 호출해야 합니다.

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

Setup Intent를 생성하여 뷰에 전달한 후에는 해당 비밀 키를 결제 방법을 수집할 요소에 연결해야 합니다. 예를 들어, 다음 "결제 방법 업데이트" 양식을 고려해 보십시오.

<input id="card-holder-name" type="text">
 
<!-- Stripe Elements 자리 표시자 -->
<div id="card-element"></div>
 
<button id="card-button" data-secret="{{ $intent->client_secret }}">
    결제 수단 업데이트
</button>

다음으로, Stripe.js 라이브러리를 사용하여 Stripe Element를 폼에 연결하고 고객의 결제 세부 정보를 안전하게 수집할 수 있습니다.

<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 애플리케이션으로 전달하여 고객에게 연결할 수 있습니다. 결제 수단은 새 결제 수단으로 추가하거나 기본 결제 수단을 업데이트하는 데 사용할 수 있습니다. 또한 결제 수단 식별자를 즉시 사용하여 새 구독을 생성할 수도 있습니다.

단일 결제에 대한 결제 수단

물론, 고객의 결제 수단에 대해 단일 결제를 수행할 때 결제 수단 식별자를 한 번만 사용하면 됩니다. Stripe 제한으로 인해 고객의 저장된 기본 결제 수단을 단일 결제에 사용할 수 없습니다. Stripe.js 라이브러리를 사용하여 고객이 결제 수단 세부 정보를 입력하도록 해야 합니다. 예를 들어 다음 양식을 고려해 보십시오.

<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를 양식에 연결하고 고객의 결제 정보를 안전하게 수집할 수 있습니다.

<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) {
        // Display "error.message" to the user...
    } else {
        // The card has been verified successfully...
    }
});

카드가 성공적으로 인증되면, paymentMethod.id를 Laravel 애플리케이션으로 전달하여 단일 결제를 처리할 수 있습니다.

결제 수단 검색

청구 가능 모델 인스턴스의 paymentMethods 메서드는 Laravel\Cashier\PaymentMethod 인스턴스 모음을 반환합니다:

$paymentMethods = $user->paymentMethods();

기본적으로 이 메서드는 모든 유형의 결제 수단을 반환합니다. 특정 유형의 결제 수단을 검색하려면 메서드에 type을 인자로 전달하면 됩니다:

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

고객의 기본 결제 수단을 검색하려면 defaultPaymentMethod 메서드를 사용할 수 있습니다:

$paymentMethod = $user->defaultPaymentMethod();

findPaymentMethod 메서드를 사용하여 청구 가능 모델에 연결된 특정 결제 수단을 검색할 수 있습니다:

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

결제 수단 존재 여부

청구 가능 모델에 계정에 연결된 기본 결제 수단이 있는지 확인하려면 hasDefaultPaymentMethod 메서드를 호출합니다:

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

hasPaymentMethod 메서드를 사용하여 청구 가능 모델에 계정에 연결된 결제 수단이 하나 이상 있는지 확인할 수 있습니다:

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

이 메서드는 청구 가능 모델에 결제 수단이 있는지 여부를 확인합니다. 모델에 특정 유형의 결제 수단이 존재하는지 확인하려면 메서드에 type을 인자로 전달하면 됩니다:

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

기본 결제 수단 업데이트

updateDefaultPaymentMethod 메서드를 사용하여 고객의 기본 결제 수단 정보를 업데이트할 수 있습니다. 이 메서드는 Stripe 결제 수단 식별자를 받아 새 결제 수단을 기본 결제 수단으로 할당합니다:

$user->updateDefaultPaymentMethod($paymentMethod);

기본 결제 수단 정보를 Stripe의 고객 기본 결제 수단 정보와 동기화하려면 updateDefaultPaymentMethodFromStripe 메서드를 사용할 수 있습니다:

$user->updateDefaultPaymentMethodFromStripe();

결제 수단 추가

새 결제 수단을 추가하려면 청구 가능 모델에서 addPaymentMethod 메서드를 호출하고 결제 수단 식별자를 전달하면 됩니다:

$user->addPaymentMethod($paymentMethod);

결제 수단 삭제

결제 수단을 삭제하려면 삭제하려는 Laravel\Cashier\PaymentMethod 인스턴스에서 delete 메서드를 호출하면 됩니다:

$paymentMethod->delete();

deletePaymentMethod 메서드는 청구 가능 모델에서 특정 결제 수단을 삭제합니다:

$user->deletePaymentMethod('pm_visa');

deletePaymentMethods 메서드는 청구 가능 모델의 모든 결제 수단 정보를 삭제합니다:

$user->deletePaymentMethods();

기본적으로 이 메서드는 모든 유형의 결제 수단을 삭제합니다. 특정 유형의 결제 수단을 삭제하려면 메서드에 type을 인자로 전달할 수 있습니다:

$user->deletePaymentMethods('sepa_debit');

구독

구독은 고객에게 반복 결제를 설정하는 방법을 제공합니다. Cashier가 관리하는 Stripe 구독은 여러 구독 가격, 구독 수량, 평가판 등을 지원합니다.

구독 생성

구독을 생성하려면 먼저 청구 가능 모델의 인스턴스를 검색해야 합니다. 일반적으로 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 결제 수단 식별자 또는 Stripe PaymentMethod 객체를 허용하는 create 메서드는 구독을 시작하고 청구 가능 모델의 Stripe 고객 ID 및 기타 관련 청구 정보로 데이터베이스를 업데이트합니다.

송장 이메일을 통해 반복 결제 수집

고객의 반복 결제를 자동으로 수집하는 대신 Stripe에 각 반복 결제 기한이 될 때마다 고객에게 송장을 이메일로 보내도록 지시할 수 있습니다. 그러면 고객은 송장을 받으면 수동으로 결제할 수 있습니다. 송장을 통해 반복 결제를 수집할 때 고객은 미리 결제 수단을 제공할 필요가 없습니다:

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

구독이 취소되기 전에 고객이 송장을 지불해야 하는 기간은 days_until_due 옵션에 따라 결정됩니다. 기본적으로 30일이지만, 원하는 경우 이 옵션에 특정 값을 제공할 수 있습니다:

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

수량

구독을 생성할 때 가격에 대한 특정 수량을 설정하려면 구독을 생성하기 전에 구독 빌더에서 quantity 메서드를 호출해야 합니다:

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

추가 세부 정보

Stripe에서 지원하는 추가 고객 또는 구독 옵션을 지정하려면 create 메서드에 두 번째 및 세 번째 인자로 전달하여 수행할 수 있습니다:

$user->newSubscription('default', 'price_monthly')->create($paymentMethod, [
    'email' => $email,
], [
    'metadata' => ['note' => '추가 정보'],
]);

쿠폰

구독을 생성할 때 쿠폰을 적용하려면 withCoupon 메서드를 사용할 수 있습니다:

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

또는 Stripe 프로모션 코드를 적용하려면 withPromotionCode 메서드를 사용할 수 있습니다:

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

지정된 프로모션 코드 ID는 고객에게 표시되는 프로모션 코드가 아닌 프로모션 코드에 할당된 Stripe API ID여야 합니다. 고객에게 표시되는 프로모션 코드를 기반으로 프로모션 코드 ID를 찾아야 하는 경우 findPromotionCode 메서드를 사용할 수 있습니다:

// 고객에게 표시되는 코드로 프로모션 코드 ID 찾기...
$promotionCode = $user->findPromotionCode('SUMMERSALE');
 
// 고객에게 표시되는 코드로 활성 프로모션 코드 ID 찾기...
$promotionCode = $user->findActivePromotionCode('SUMMERSALE');

위의 예에서 반환된 $promotionCode 객체는 Laravel\Cashier\PromotionCode의 인스턴스입니다. 이 클래스는 기본 Stripe\PromotionCode 객체를 장식합니다. coupon 메서드를 호출하여 프로모션 코드와 관련된 쿠폰을 검색할 수 있습니다:

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

쿠폰 인스턴스를 사용하면 할인 금액과 쿠폰이 고정 할인인지 백분율 기반 할인인지 여부를 확인할 수 있습니다:

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

현재 고객 또는 구독에 적용된 할인을 검색할 수도 있습니다:

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

반환된 Laravel\Cashier\Discount 인스턴스는 기본 Stripe\Discount 객체 인스턴스를 장식합니다. coupon 메서드를 호출하여 이 할인과 관련된 쿠폰을 검색할 수 있습니다:

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

새 쿠폰 또는 프로모션 코드를 고객 또는 구독에 적용하려면 applyCoupon 또는 applyPromotionCode 메서드를 통해 수행할 수 있습니다:

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

고객에게 표시되는 프로모션 코드가 아닌 프로모션 코드에 할당된 Stripe API ID를 사용해야 합니다. 고객 또는 구독에는 한 번에 하나의 쿠폰 또는 프로모션 코드만 적용할 수 있습니다.

이 주제에 대한 자세한 내용은 쿠폰 및 프로모션 코드에 관한 Stripe 설명서를 참조하십시오.

구독 추가

이미 기본 결제 수단을 가지고 있는 고객에게 구독을 추가하려면 구독 빌더에서 add 메서드를 호출하면 됩니다:

use App\Models\User;
 
$user = User::find(1);
 
$user->newSubscription('default', 'price_monthly')->add();

Stripe 대시보드에서 구독 생성

Stripe 대시보드 자체에서 구독을 생성할 수도 있습니다. 이렇게 하면 Cashier는 새로 추가된 구독을 동기화하고 default 유형을 할당합니다. 대시보드에서 생성된 구독에 할당된 구독 유형을 사용자 지정하려면 웹후크 이벤트 처리기 정의를 참조하세요.

또한 Stripe 대시보드를 통해 한 가지 유형의 구독만 생성할 수 있습니다. 애플리케이션에서 다른 유형을 사용하는 여러 구독을 제공하는 경우, Stripe 대시보드를 통해 한 가지 유형의 구독만 추가할 수 있습니다.

마지막으로, 애플리케이션에서 제공하는 구독 유형당 하나의 활성 구독만 추가해야 합니다. 고객에게 default 유형의 구독이 두 개 있는 경우, 둘 다 애플리케이션 데이터베이스와 동기화되더라도 가장 최근에 추가된 구독만 Cashier에서 사용됩니다.

구독 상태 확인

고객이 애플리케이션을 구독하면 다양한 편리한 방법을 사용하여 구독 상태를 쉽게 확인할 수 있습니다. 먼저 subscribed 메서드는 구독이 현재 평가판 기간 내에 있는 경우에도 고객이 활성 구독을 가지고 있으면 true를 반환합니다. subscribed 메서드는 구독 유형을 첫 번째 인자로 허용합니다:

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

subscribed 메서드는 경로 미들웨어에 훌륭한 후보가 되어 사용자 구독 상태에 따라 경로 및 컨트롤러에 대한 액세스를 필터링할 수 있습니다:

<?php
 
namespace App\Http\Middleware;
 
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
 
class EnsureUserIsSubscribed
{
    /**
     * 들어오는 요청을 처리합니다.
     *
     * @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')) {
            // 이 사용자는 유료 고객이 아닙니다...
            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 구독이 애플리케이션의 "기본" 또는 "프리미엄" 제품을 활성 상태로 구독하는지 확인할 수 있습니다:

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

subscribedToPrice 메서드를 사용하여 고객의 구독이 지정된 가격 ID와 일치하는지 확인할 수 있습니다:

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

recurring 메서드를 사용하여 사용자가 현재 구독 중이고 더 이상 평가판 기간 내에 있지 않은지 확인할 수 있습니다:

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

취소된 구독 상태

사용자가 한때 활성 구독자였지만 구독을 취소했는지 확인하려면 canceled 메서드를 사용할 수 있습니다:

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

또한 사용자가 구독을 취소했지만 구독이 완전히 만료될 때까지 "유예 기간"에 있는지 여부를 확인할 수도 있습니다. 예를 들어, 원래 3월 10일에 만료되도록 예정되었던 구독을 3월 5일에 사용자가 취소하면 사용자는 3월 10일까지 "유예 기간"에 있습니다. subscribed 메서드는 이 기간 동안에도 true를 반환합니다:

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

사용자가 구독을 취소하고 더 이상 "유예 기간" 내에 있지 않은지 확인하려면 ended 메서드를 사용할 수 있습니다:

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

불완전 및 연체 상태

구독 생성 후 보조 결제 작업이 필요한 경우 구독은 불완전으로 표시됩니다. 구독 상태는 Cashier의 subscriptions 데이터베이스 테이블의 stripe_status 열에 저장됩니다.

마찬가지로 가격을 변경할 때 보조 결제 작업이 필요한 경우 구독은 연체로 표시됩니다. 구독이 이러한 상태 중 하나에 있는 경우 고객이 결제를 확인하기 전까지는 활성화되지 않습니다. 구독에 불완전한 결제가 있는지 확인하는 것은 청구 가능 모델 또는 구독 인스턴스에서 hasIncompletePayment 메서드를 사용하여 수행할 수 있습니다:

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

구독에 불완전한 결제가 있는 경우 사용자를 Cashier 결제 확인 페이지로 안내하고 latestPayment 식별자를 전달해야 합니다. 구독 인스턴스에서 사용할 수 있는 latestPayment 메서드를 사용하여 이 식별자를 검색할 수 있습니다:

<a href="{{ route('cashier.payment', $subscription->latestPayment()->id) }}">
    결제를 확인해주세요.
</a>

past_due 또는 incomplete 상태일 때도 구독을 활성 상태로 간주하고 싶다면 Cashier에서 제공하는 keepPastDueSubscriptionsActive 및 keepIncompleteSubscriptionsActive 메서드를 사용할 수 있습니다. 일반적으로 이러한 메서드는 App\Providers\AppServiceProvider의 register 메서드에서 호출해야 합니다.

use Laravel\Cashier\Cashier;
 
/**
 * 애플리케이션 서비스 등록.
 */
public function register(): void
{
    Cashier::keepPastDueSubscriptionsActive();
    Cashier::keepIncompleteSubscriptionsActive();
}

[!경고] 구독이 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 문서를 참조하십시오.

[!경고] swapAndInvoice 메서드 전에 noProrate 메서드를 실행하면 비례 배분에 아무런 영향을 미치지 않습니다. 송장은 항상 발행됩니다.

구독 수량

구독은 때때로 "수량"의 영향을 받습니다. 예를 들어, 프로젝트 관리 애플리케이션은 프로젝트당 월 10달러를 부과할 수 있습니다. incrementQuantity 및 decrementQuantity 메서드를 사용하여 구독 수량을 쉽게 늘리거나 줄일 수 있습니다.

use App\Models\User;
 
$user = User::find(1);
 
$user->subscription('default')->incrementQuantity();
 
// 구독의 현재 수량에 5를 추가합니다...
$user->subscription('default')->incrementQuantity(5);
 
$user->subscription('default')->decrementQuantity();
 
// 구독의 현재 수량에서 5를 뺍니다...
$user->subscription('default')->decrementQuantity(5);

또는 updateQuantity 메서드를 사용하여 특정 수량을 설정할 수도 있습니다.

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

noProrate 메서드를 사용하여 요금을 비례 배분하지 않고 구독 수량을 업데이트할 수 있습니다.

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

구독 수량에 대한 자세한 내용은 Stripe 문서를 참조하십시오.

여러 제품이 있는 구독의 수량

구독이 여러 제품이 있는 구독인 경우, 수량을 늘리거나 줄이려는 가격의 ID를 increment/decrement 메서드의 두 번째 인수로 전달해야 합니다.

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

여러 제품이 있는 구독

여러 제품이 있는 구독을 사용하면 여러 개의 청구 제품을 단일 구독에 할당할 수 있습니다. 예를 들어, 기본 구독 가격이 월 10달러이지만 추가로 월 15달러에 실시간 채팅 추가 기능 제품을 제공하는 고객 서비스 "헬프 데스크" 애플리케이션을 구축하고 있다고 가정해 보십시오. 여러 제품이 있는 구독에 대한 정보는 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');

[!경고] 구독에서 마지막 가격은 제거할 수 없습니다. 대신 구독을 취소해야 합니다.

가격 바꾸기

여러 제품이 있는 구독에 연결된 가격을 변경할 수도 있습니다. 예를 들어, 고객에게 price_chat 추가 기능 제품이 있는 price_basic 구독이 있고 고객을 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');

수량

개별 구독 가격에 대한 수량을 업데이트하고 싶다면 메서드에 추가 인수로 가격 ID를 전달하여 기존 수량 메서드를 사용하여 그렇게 할 수 있습니다.

$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 관계를 통해 접근할 수 있습니다.

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를 사용하면 고객이 여러 개의 구독을 동시에 가질 수 있습니다. 예를 들어, 수영 구독과 역도 구독을 제공하는 체육관을 운영할 수 있으며 각 구독에는 다른 가격이 있을 수 있습니다. 물론 고객은 하나 또는 두 플랜 모두 구독할 수 있어야 합니다.

애플리케이션에서 구독을 생성할 때 newSubscription 메서드에 구독 유형을 제공할 수 있습니다. 유형은 사용자가 시작하는 구독 유형을 나타내는 임의의 문자열일 수 있습니다.

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

이 예에서는 고객에 대해 월간 수영 구독을 시작했습니다. 그러나 나중에 연간 구독으로 바꾸고 싶을 수도 있습니다. 고객의 구독을 조정할 때 swimming 구독에서 가격만 바꾸면 됩니다.

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

물론 구독을 완전히 취소할 수도 있습니다.

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

사용량 기반 청구

사용량 기반 청구를 사용하면 청구 주기 동안의 제품 사용량을 기준으로 고객에게 요금을 청구할 수 있습니다. 예를 들어, 고객에게 매달 보내는 문자 메시지 또는 이메일 수에 따라 요금을 청구할 수 있습니다.

사용량 기반 청구를 시작하려면 먼저 사용량 기반 청구 모델과 미터를 사용하여 Stripe 대시보드에서 새 제품을 생성해야 합니다. 미터를 생성한 후에는 사용량을 보고하고 검색하는 데 필요한 관련 이벤트 이름과 미터 ID를 저장합니다. 그런 다음 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을 통해 측정된 구독을 시작할 수도 있습니다.

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

사용량 보고

고객이 애플리케이션을 사용할 때 정확하게 요금이 청구되도록 Stripe에 사용량을 보고합니다. 측정된 이벤트의 사용량을 보고하려면 Billable 모델에서 reportMeterEvent 메서드를 사용할 수 있습니다.

$user = User::find(1);
 
$user->reportMeterEvent('emails-sent');

기본적으로 청구 기간에 "사용량" 1이 추가됩니다. 또는 청구 기간에 고객의 사용량에 추가할 특정 "사용량" 금액을 전달할 수도 있습니다.

$user = User::find(1);
 
$user->reportMeterEvent('emails-sent', quantity: 15);

미터에 대한 고객의 이벤트 요약을 검색하려면 Billable 인스턴스의 meterEventSummaries 메서드를 사용할 수 있습니다.

$user = User::find(1);
 
$meterUsage = $user->meterEventSummaries($meterId);
 
$meterUsage->first()->aggregated_value // 10

미터 이벤트 요약에 대한 자세한 내용은 Stripe의 미터 이벤트 요약 객체 문서를 참조하십시오.

모든 미터를 나열하려면 Billable 인스턴스의 meters 메서드를 사용할 수 있습니다.

$user = User::find(1);
 
$user->meters();

구독 세금

[!경고] 수동으로 세율을 계산하는 대신 Stripe Tax를 사용하여 세금을 자동으로 계산할 수 있습니다.

사용자가 구독에 대해 지불하는 세율을 지정하려면 청구 가능 모델에서 taxRates 메서드를 구현하고 Stripe 세율 ID를 포함하는 배열을 반환해야 합니다. Stripe 대시보드에서 이러한 세율을 정의할 수 있습니다.

/**
 * 고객의 구독에 적용해야 하는 세율.
 *
 * @return array<int, string>
 */
public function taxRates(): array
{
    return ['txr_id'];
}

taxRates 메서드를 사용하면 여러 국가 및 세율에 걸쳐 있는 사용자 기반에 유용할 수 있는 고객별로 세율을 적용할 수 있습니다.

여러 제품으로 구독을 제공하는 경우 청구 가능 모델에서 priceTaxRates 메서드를 구현하여 각 가격에 대해 다른 세율을 정의할 수 있습니다.

/**
 * 고객의 구독에 적용해야 하는 세율.
 *
 * @return array<string, array<int, string>>
 */
public function priceTaxRates(): array
{
    return [
        'price_monthly' => ['txr_id'],
    ];
}

[!경고] taxRates 메서드는 구독 요금에만 적용됩니다. Cashier를 사용하여 "일회성" 요금을 청구하는 경우 해당 시점에 수동으로 세율을 지정해야 합니다.

세율 동기화

taxRates 메서드에서 반환된 하드 코딩된 세율 ID를 변경하면 해당 사용자의 기존 구독에 대한 세금 설정은 동일하게 유지됩니다. 기존 구독의 세금 값을 새로운 taxRates 값으로 업데이트하고 싶다면 사용자의 구독 인스턴스에서 syncTaxRates 메서드를 호출해야 합니다.

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

이렇게 하면 여러 제품이 있는 구독에 대한 항목 세율도 동기화됩니다. 애플리케이션이 여러 제품으로 구독을 제공하는 경우 청구 가능 모델이 위에서 논의한 priceTaxRates 메서드를 구현하는지 확인해야 합니다.

세금 면제

Cashier는 또한 고객이 세금 면제 대상인지 여부를 확인하기 위해 isNotTaxExempt, isTaxExempt 및 reverseChargeApplies 메서드를 제공합니다. 이러한 메서드는 Stripe API를 호출하여 고객의 세금 면제 상태를 확인합니다.

use App\Models\User;
 
$user = User::find(1);
 
$user->isTaxExempt();
$user->isNotTaxExempt();
$user->reverseChargeApplies();

[!경고] 이러한 메서드는 Laravel\Cashier\Invoice 객체에서도 사용할 수 있습니다. 그러나 Invoice 객체에서 호출될 때 메서드는 송장이 생성된 시점의 면제 상태를 결정합니다.

구독 앵커 날짜

기본적으로 청구 주기 앵커는 구독이 생성된 날짜이거나 체험 기간을 사용하는 경우 체험이 종료되는 날짜입니다. 청구 앵커 날짜를 수정하고 싶다면 anchorBillingCycleOn 메서드를 사용할 수 있습니다.

use Illuminate\Http\Request;
 
Route::post('/user/subscribe', function (Request $request) {
    $anchor = Carbon::parse('다음 달 첫날');
 
    $request->user()->newSubscription('default', 'price_monthly')
                ->anchorBillingCycleOn($anchor->startOfDay())
                ->create($request->paymentMethodId);
 
    // ...
});

구독 청구 주기 관리에 대한 자세한 내용은 Stripe 청구 주기 문서를 참조하십시오.

구독 취소

구독을 취소하려면 사용자의 구독에서 cancel 메서드를 호출합니다.

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

구독이 취소되면 Cashier는 subscriptions 데이터베이스 테이블에 ends_at 열을 자동으로 설정합니다. 이 열은 subscribed 메서드가 언제 false를 반환하기 시작해야 하는지 알기 위해 사용됩니다.

예를 들어, 고객이 3월 1일에 구독을 취소했지만 구독이 3월 5일까지 종료되도록 예약되지 않은 경우 subscribed 메서드는 3월 5일까지 true를 계속 반환합니다. 이는 일반적으로 사용자가 청구 주기가 끝날 때까지 애플리케이션을 계속 사용할 수 있기 때문입니다.

사용자가 구독을 취소했지만 여전히 "유예 기간"에 있는지 여부는 onGracePeriod 메서드를 사용하여 확인할 수 있습니다.

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

구독을 즉시 취소하고 싶다면 사용자의 구독에서 cancelNow 메서드를 호출합니다.

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

구독을 즉시 취소하고 아직 청구되지 않은 측정된 사용량이나 신규/보류 중인 비례 배분 송장 항목에 대한 송장을 발행하고 싶다면 사용자의 구독에서 cancelNowAndInvoice 메서드를 호출합니다.

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

특정 시점에 구독을 취소하도록 선택할 수도 있습니다.

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

마지막으로 관련 사용자 모델을 삭제하기 전에 항상 사용자 구독을 취소해야 합니다.

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

구독 재개

고객이 구독을 취소했고 구독을 재개하고 싶다면 구독에서 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에서 가격에 대해 구성된 기본 체험 기간을 덮어씁니다.

[!경고] 고객의 구독이 체험 종료 날짜 전에 취소되지 않으면 체험이 만료되는 즉시 요금이 청구되므로 사용자에게 체험 종료 날짜를 알려야 합니다.

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

기존 평가판이 만료되었는지 확인하려면 hasExpiredTrial 메서드를 사용할 수 있습니다.

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

Stripe/Cashier에서 체험 일수 정의

Stripe 대시보드에서 가격이 받을 체험 일수를 정의하거나 항상 Cashier를 사용하여 명시적으로 전달하도록 선택할 수 있습니다. Stripe에서 가격의 체험 일수를 정의하도록 선택한 경우, 과거에 구독을 한 고객의 새로운 구독을 포함한 새로운 구독은 명시적으로 skipTrial() 메서드를 호출하지 않는 한 항상 체험 기간을 받게 됩니다.

사전 결제 방법 없이

사용자의 결제 방법 정보를 미리 수집하지 않고 체험 기간을 제공하고 싶다면 사용자 레코드의 trial_ends_at 열을 원하는 체험 종료 날짜로 설정하면 됩니다. 이는 일반적으로 사용자 등록 중에 수행됩니다.

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

[!경고] 청구 가능 모델의 클래스 정의 내에서 trial_ends_at 속성에 대한 날짜 캐스트를 추가해야 합니다.

Cashier는 이 유형의 체험을 기존 구독에 연결되어 있지 않기 때문에 "일반 체험"이라고 합니다. 현재 날짜가 trial_ends_at 값보다 지나지 않은 경우 청구 가능 모델 인스턴스의 onTrial 메서드는 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');
 
// 지금부터 7일 후 평가판 종료...
$subscription->extendTrial(
    now()->addDays(7)
);
 
// 평가판에 5일 더 추가...
$subscription->extendTrial(
    $subscription->trial_ends_at->addDays(5)
);

Stripe 웹후크 처리

[!참고] 로컬 개발 중에 웹후크를 테스트하는 데 도움이 되도록 Stripe CLI를 사용할 수 있습니다.

Stripe는 웹후크를 통해 다양한 이벤트를 애플리케이션에 알릴 수 있습니다. 기본적으로 Cashier 서비스 공급자가 Cashier의 웹후크 컨트롤러를 가리키는 경로를 자동으로 등록합니다. 이 컨트롤러는 들어오는 모든 웹후크 요청을 처리합니다.

기본적으로 Cashier 웹후크 컨트롤러는 (Stripe 설정에 정의된 대로) 실패한 요금이 너무 많은 구독, 고객 업데이트, 고객 삭제, 구독 업데이트 및 결제 방법 변경을 자동으로 처리합니다. 하지만 곧 알게 되겠지만 이 컨트롤러를 확장하여 원하는 Stripe 웹후크 이벤트를 처리할 수 있습니다.

애플리케이션에서 Stripe 웹후크를 처리할 수 있도록 하려면 Stripe 제어판에서 웹후크 URL을 구성해야 합니다. 기본적으로 Cashier의 웹후크 컨트롤러는 /stripe/webhook URL 경로에 응답합니다. Stripe 제어판에서 활성화해야 하는 모든 웹후크의 전체 목록은 다음과 같습니다.

• 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 명령이 포함되어 있습니다. 이 명령은 Cashier에 필요한 모든 이벤트를 수신하는 Stripe에서 웹후크를 생성합니다.

php artisan cashier:webhook

기본적으로 생성된 웹훅은 APP_URL 환경 변수에 정의된 URL과 Cashier에 포함된 cashier.webhook 라우트를 가리킵니다. 다른 URL을 사용하고 싶다면 명령어를 호출할 때 --url 옵션을 제공할 수 있습니다.

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

생성되는 웹훅은 사용 중인 Cashier 버전과 호환되는 Stripe API 버전을 사용합니다. 다른 Stripe 버전을 사용하고 싶다면 --api-version 옵션을 제공할 수 있습니다.

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

생성 후, 웹훅은 즉시 활성화됩니다. 웹훅을 생성하되 준비가 될 때까지 비활성화하고 싶다면 명령어를 호출할 때 --disabled 옵션을 제공할 수 있습니다.

php artisan cashier:webhook --disabled

웹훅 및 CSRF 보호

Stripe 웹훅은 Laravel의 CSRF 보호를 우회해야 하므로, Laravel이 들어오는 Stripe 웹훅에 대한 CSRF 토큰의 유효성을 검사하지 않도록 해야 합니다. 이를 위해 애플리케이션의 bootstrap/app.php 파일에서 CSRF 보호로부터 stripe/*를 제외해야 합니다.

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

웹훅 이벤트 핸들러 정의

Cashier는 실패한 청구 및 기타 일반적인 Stripe 웹훅 이벤트에 대한 구독 취소를 자동으로 처리합니다. 그러나 처리하려는 추가 웹훅 이벤트가 있는 경우, Cashier에서 디스패치하는 다음 이벤트를 수신하여 처리할 수 있습니다.

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

두 이벤트 모두 Stripe 웹훅의 전체 페이로드를 포함합니다. 예를 들어, invoice.payment_succeeded 웹훅을 처리하려면 이벤트를 처리할 리스너를 등록할 수 있습니다.

<?php
 
namespace App\Listeners;
 
use Laravel\Cashier\Events\WebhookReceived;
 
class StripeEventListener
{
    /**
     * 수신된 Stripe 웹훅을 처리합니다.
     */
    public function handle(WebhookReceived $event): void
    {
        if ($event->payload['type'] === 'invoice.payment_succeeded') {
            // 들어오는 이벤트 처리...
        }
    }
}

웹훅 서명 확인

웹훅을 보호하기 위해 Stripe의 웹훅 서명을 사용할 수 있습니다. 편의를 위해 Cashier는 들어오는 Stripe 웹훅 요청이 유효한지 확인하는 미들웨어를 자동으로 포함합니다.

웹훅 확인을 활성화하려면 애플리케이션의 .env 파일에 STRIPE_WEBHOOK_SECRET 환경 변수가 설정되어 있는지 확인하십시오. 웹훅 secret은 Stripe 계정 대시보드에서 검색할 수 있습니다.

단일 청구

간단한 청구

고객에게 일회성 청구를 하려면 청구 가능 모델 인스턴스에서 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 메서드를 사용할 수도 있습니다. 이를 위해 애플리케이션의 청구 가능 모델의 새 인스턴스에서 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'],
]);

invoicePrice와 유사하게 tabPrice 메서드를 사용하여 여러 항목(송장당 최대 250개 항목)을 고객의 "탭"에 추가한 다음 고객에게 송장을 발행하여 일회성 청구를 만들 수 있습니다. 예를 들어, 고객에게 셔츠 5개와 머그 2개에 대한 송장을 발행할 수 있습니다.

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

또는 invoiceFor 메서드를 사용하여 고객의 기본 결제 방법에 대해 "일회성" 청구를 할 수 있습니다.

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

invoiceFor 메서드를 사용할 수 있지만, 미리 정의된 가격으로 invoicePrice 및 tabPrice 메서드를 사용하는 것이 좋습니다. 그렇게 하면 제품별 판매에 관한 Stripe 대시보드 내에서 더 나은 분석 및 데이터에 액세스할 수 있습니다.

결제 인텐트 생성

청구 가능 모델 인스턴스에서 pay 메서드를 호출하여 새로운 Stripe 결제 인텐트를 만들 수 있습니다. 이 메서드를 호출하면 Laravel\Cashier\Payment 인스턴스에 래핑된 결제 인텐트가 생성됩니다.

use Illuminate\Http\Request;
 
Route::post('/pay', function (Request $request) {
    $payment = $request->user()->pay(
        $request->get('amount')
    );
 
    return $payment->client_secret;
});

결제 인텐트를 만든 후에는 사용자가 브라우저에서 결제를 완료할 수 있도록 클라이언트 비밀을 애플리케이션의 프런트엔드로 반환할 수 있습니다. Stripe 결제 인텐트를 사용하여 전체 결제 흐름을 구축하는 방법에 대한 자세한 내용은 Stripe 문서를 참조하십시오.

pay 메서드를 사용할 때 Stripe 대시보드 내에서 활성화된 기본 결제 방법을 고객이 사용할 수 있습니다. 또는 일부 특정 결제 방법만 사용하도록 허용하려면 payWith 메서드를 사용할 수 있습니다.

use Illuminate\Http\Request;
 
Route::post('/pay', function (Request $request) {
    $payment = $request->user()->payWith(
        $request->get('amount'), ['card', 'bancontact']
    );
 
    return $payment->client_secret;
});

청구 환불

Stripe 청구를 환불해야 하는 경우 refund 메서드를 사용할 수 있습니다. 이 메서드는 첫 번째 인수로 Stripe 결제 인텐트 ID를 허용합니다.

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

송장

송장 검색

invoices 메서드를 사용하여 청구 가능 모델의 송장 배열을 쉽게 검색할 수 있습니다. invoices 메서드는 Laravel\Cashier\Invoice 인스턴스의 컬렉션을 반환합니다.

$invoices = $user->invoices();

결과에 보류 중인 송장을 포함하려면 invoicesIncludingPending 메서드를 사용할 수 있습니다.

$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 }}">다운로드</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']);

송장 PDF 생성

송장 PDF를 생성하기 전에 Composer를 사용하여 Cashier의 기본 송장 렌더러인 Dompdf 라이브러리를 설치해야 합니다.

composer require dompdf/dompdf

라우트 또는 컨트롤러 내에서 downloadInvoice 메서드를 사용하여 주어진 송장의 PDF 다운로드를 생성할 수 있습니다. 이 메서드는 송장을 다운로드하는 데 필요한 적절한 HTTP 응답을 자동으로 생성합니다.

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

기본적으로 송장의 모든 데이터는 Stripe에 저장된 고객 및 송장 데이터에서 파생됩니다. 파일 이름은 app.name 구성 값을 기반으로 합니다. 그러나 downloadInvoice 메서드의 두 번째 인수로 배열을 제공하여 이 데이터의 일부를 사용자 지정할 수 있습니다. 이 배열을 통해 회사 및 제품 세부 정보와 같은 정보를 사용자 지정할 수 있습니다.

return $request->user()->downloadInvoice($invoiceId, [
    'vendor' => '귀사',
    '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가 접미사로 붙습니다.

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

사용자 지정 송장 렌더러

Cashier는 사용자 지정 송장 렌더러를 사용할 수 있도록 합니다. 기본적으로 Cashier는 dompdf PHP 라이브러리를 사용하여 Cashier의 송장을 생성하는 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 바이트를 반환합니다.
     */
    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에 대해 자세히 알아보려면 Checkout에 대한 Stripe 자체 문서도 검토하는 것이 좋습니다.

제품 결제

청구 가능 모델에서 checkout 메서드를 사용하여 Stripe 대시보드 내에서 생성된 기존 제품에 대한 결제를 수행할 수 있습니다. checkout 메서드는 새로운 Stripe Checkout 세션을 시작합니다. 기본적으로 Stripe Price 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의 Checkout 페이지로 리디렉션됩니다. 기본적으로 사용자가 구매를 성공적으로 완료하거나 취소하면 사용자는 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을 호출할 때 Stripe에 결제 세션 ID를 쿼리 문자열 매개변수로 추가하도록 지시할 수 있습니다. 이렇게 하려면 success_url 쿼리 문자열에 리터럴 문자열 {CHECKOUT_SESSION_ID}를 추가합니다. 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은 사용자가 사용할 수 있는 프로모션 코드를 허용하지 않습니다. 다행히도 Checkout 페이지에서 이러한 코드를 활성화하는 쉬운 방법이 있습니다. 이렇게 하려면 allowPromotionCodes 메서드를 호출하면 됩니다.

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

단일 요금 결제

Stripe 대시보드에서 생성되지 않은 임시 제품에 대한 간단한 요금을 수행할 수도 있습니다. 이렇게 하려면 청구 가능한 모델에서 checkoutCharge 메서드를 사용하고 청구 가능한 금액, 제품 이름 및 선택적 수량을 전달할 수 있습니다. 고객이 이 라우트를 방문하면 Stripe의 Checkout 페이지로 리디렉션됩니다.

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

구독 결제

Stripe Checkout을 사용하여 구독을 시작할 수도 있습니다. Cashier의 구독 빌더 메서드로 구독을 정의한 후 checkout 메서드를 호출할 수 있습니다. 고객이 이 라우트를 방문하면 Stripe의 Checkout 페이지로 리디렉션됩니다.

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

Stripe Checkout 및 평가판 기간

물론 Stripe Checkout을 사용하여 완료할 구독을 구축할 때 평가판 기간을 정의할 수 있습니다.

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