구독 통합 가이드

​

전제 조건

• Dodo Payments 상인 계정
• 대시보드에서 API 자격 증명 (API 키 및 웹훅 비밀 키)

​

API 통합

​

체크아웃 세션

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode', // defaults to 'live_mode'
});

async function main() {
  const session = await client.checkoutSessions.create({
    product_cart: [
      { product_id: 'prod_subscription_monthly', quantity: 1 }
    ],
    // Optional: configure trials for subscription products
    subscription_data: { trial_period_days: 14 },
    customer: {
      email: 'subscriber@example.com',
      name: 'Jane Doe',
    },
    return_url: 'https://example.com/success',
  });

  console.log(session.checkout_url);
}

main();

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",  # defaults to "live_mode"
)

session = client.checkout_sessions.create(
    product_cart=[
        {"product_id": "prod_subscription_monthly", "quantity": 1}
    ],
    subscription_data={"trial_period_days": 14},  # optional
    customer={
        "email": "subscriber@example.com",
        "name": "Jane Doe",
    },
    return_url="https://example.com/success",
)

print(session.checkout_url)

const response = await fetch('https://test.dodopayments.com/checkouts', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.DODO_PAYMENTS_API_KEY}`
  },
  body: JSON.stringify({
    product_cart: [
      { product_id: 'prod_subscription_monthly', quantity: 1 }
    ],
    subscription_data: { trial_period_days: 14 }, // optional
    customer: {
      email: 'subscriber@example.com',
      name: 'Jane Doe'
    },
    return_url: 'https://example.com/success'
  })
});

if (!response.ok) {
  throw new Error(`HTTP error! status: ${response.status}`);
}

const session = await response.json();
console.log(session.checkout_url);

​

API 응답

{
  "session_id": "cks_Gi6KGJ2zFJo9rq9Ukifwa",
  "checkout_url": "https://test.checkout.dodopayments.com/session/cks_Gi6KGJ2zFJo9rq9Ukifwa"
}

​

웹훅

​

구독 이벤트 유형

1. subscription.active - 구독이 성공적으로 활성화되었습니다.
2. subscription.updated - 구독 개체가 업데이트되었습니다 (필드가 변경될 때마다 발생합니다).
3. subscription.on_hold - 갱신 실패로 인해 구독이 보류 상태로 전환됩니다.
4. subscription.failed - mandate 생성 실패로 인해 구독 생성에 실패했습니다.
5. subscription.renewed - 다음 청구 기간을 위해 구독이 갱신되었습니다.

​

결제 시나리오

1. subscription.active: mandate가 승인되고 subscription이 활성화됩니다.
2. payment.succeeded: 첫 번째 청구를 확인합니다. checkout 후 2~10분 이내에 발생할 것으로 예상됩니다.

1. 시험 시작 시(checkout): 결제 수단이 승인되면 subscription.active가 한 번 발생합니다. 아직 recurring charge는 청구되지 않습니다. 첫 번째 실제 청구는 시험 기간이 종료될 때까지 연기됩니다.
2. 시험 종료 시: recurring amount가 청구되며, payment.succeeded를 subscription.renewed와 함께 수신합니다.

• subscription.renewed: 각 billing cycle에서 renewal payment가 차감될 때 발생하며, 항상 payment.succeeded와 함께 전송됩니다. 또한 업데이트된 next_billing_date도 포함합니다.

1. Subscription Failure

• subscription.failed - mandate 생성 실패로 인해 subscription 생성에 실패했습니다.
• payment.failed - 결제 실패를 나타냅니다.

2. Subscription On Hold

• subscription.on_hold - renewal payment 또는 plan change charge 실패로 인해 subscription이 보류됩니다.
• subscription이 보류되면 payment method가 업데이트될 때까지 자동으로 renewal되지 않습니다.

​

subscription.failed와 subscription.on_hold 비교

​

보류된 Subscription 처리

​

Subscription이 보류되는 경우

• Renewal payment 실패: 잔액 부족, 만료된 카드 또는 은행 거절로 인해 자동 renewal charge가 실패함
• Plan change charge 실패: plan upgrade/downgrade 중 즉시 charge가 실패함
• Payment method authorization 실패: recurring charge에 대해 payment method를 승인할 수 없음

​

보류된 Subscription 다시 활성화

1. 미납 잔액에 대한 charge 생성
2. 해당 charge에 대한 invoice 생성
3. 새 payment method를 사용하여 payment 처리
4. payment 성공 시 subscription을 active 상태로 재활성화

// Webhook handler
app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;
  
  if (event.type === 'subscription.on_hold') {
    const subscription = event.data;
    
    // Update subscription status in your database
    await updateSubscriptionStatus(subscription.subscription_id, 'on_hold');
    
    // Notify customer to update payment method
    await sendEmailToCustomer(subscription.customer_id, {
      subject: 'Payment Required - Subscription On Hold',
      message: 'Your subscription is on hold. Please update your payment method to continue service.'
    });
  }
  
  res.json({ received: true });
});

// Update with new payment method
const response = await client.subscriptions.updatePaymentMethod(subscriptionId, {
  payment_method: { type: 'new', return_url: 'https://example.com/return' }
});

// For on_hold subscriptions, a charge is automatically created
if (response.payment_id) {
  console.log('Charge created for remaining dues:', response.payment_id);
  // Redirect customer to response.payment_link to complete payment
}

# Update with new payment method
response = client.subscriptions.update_payment_method(
    subscription_id=subscription_id,
    payment_method={"type": "new", "return_url": "https://example.com/return"},
)

# For on_hold subscriptions, a charge is automatically created
if response.payment_id:
    print("Charge created for remaining dues:", response.payment_id)
    # Redirect customer to response.payment_link to complete payment

await client.subscriptions.updatePaymentMethod(subscriptionId, {
  payment_method: { type: 'existing', payment_method_id: 'pm_abc123' }
});

if (event.type === 'payment.succeeded') {
  const payment = event.data;
  
  // Check if this payment is for an on_hold subscription
  if (payment.subscription_id) {
    // Wait for subscription.active webhook to confirm reactivation
  }
}

if (event.type === 'subscription.active') {
  const subscription = event.data;
  
  // Update subscription status in your database
  await updateSubscriptionStatus(subscription.subscription_id, 'active');
  
  // Restore customer access
  await restoreCustomerAccess(subscription.customer_id);
  
  // Notify customer of successful reactivation
  await sendEmailToCustomer(subscription.customer_id, {
    subject: 'Subscription Reactivated',
    message: 'Your subscription has been reactivated successfully.'
  });
}

​

Subscription event payload 예시

​

Subscription Plan 변경

​

Proration 옵션

​

1. prorated_immediately

• 현재 billing cycle의 남은 시간을 기준으로 prorated amount를 계산합니다.
• 기존 plan과 새 plan의 차액만 고객에게 청구합니다.
• trial 기간에는 사용자를 즉시 새 plan으로 전환하고 고객에게 바로 청구합니다.

​

2. full_immediately

• 새 plan의 전체 subscription amount를 고객에게 청구합니다.
• 이전 plan의 남은 시간이나 credit을 무시합니다.
• billing cycle을 reset하거나 proration과 관계없이 전체 금액을 청구하려는 경우에 유용합니다.

​

3. difference_immediately

• upgrade하는 경우 두 plan 금액의 차액이 고객에게 즉시 청구됩니다.
• 예를 들어 현재 plan이 30 Dollars이고 고객이 80 Dollars plan으로 upgrade하면 즉시 $50가 청구됩니다.
• downgrade하는 경우 현재 plan의 미사용 금액이 internal credit으로 추가되고 향후 subscription renewal에 자동으로 적용됩니다.
• 예를 들어 현재 plan이 50 Dollars이고 고객이 20 Dollars plan으로 전환하면 남은 $30가 credit으로 적립되어 다음 billing cycle에 사용됩니다.

​

4. do_not_bill

• plan 변경을 즉시 적용하지만 변경 시점에는 아무것도 청구하지 않습니다.
• 업데이트된 plan(및 quantity/add-ons)은 다음 예정된 renewal에 청구되며, 기존 billing date가 유지됩니다.

​

동작

• 이 API를 호출하면 Dodo Payments가 선택한 proration 옵션에 따라 즉시 charge를 시작합니다.
• plan 변경이 downgrade이고 prorated_immediately를 사용하는 경우 credit이 자동으로 계산되어 subscription의 credit balance에 추가됩니다. 이 credit은 해당 subscription에만 적용되며 동일한 subscription의 향후 recurring payment를 상쇄하는 데만 사용됩니다.
• full_immediately 옵션은 credit 계산을 건너뛰고 새 plan의 전체 금액을 청구합니다.

​

Charge 처리

• plan 변경 시 시작된 즉시 charge는 일반적으로 2분 이내에 처리가 완료됩니다.
• 이 즉시 charge가 어떤 이유로든 실패하면 문제가 해결될 때까지 subscription이 자동으로 보류됩니다.

​

On-Demand Subscription

​

구독 청구에 대해 알아야 할 주요 사항

​

관련 API Reference