구독 통합 가이드

사전 요구 사항

• Dodo Payments merchant account
• 대시보드의 Developer → API Keys에서 발급한 API key를 DODO_PAYMENTS_API_KEY에 저장
• Developer → Webhooks에서 발급한 webhook secret을 DODO_PAYMENTS_WEBHOOK_KEY에 저장
• Products에서 생성된 subscription product 하나 이상

API 통합

Checkout Session

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: 'pdt_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": "pdt_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: 'pdt_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 Response

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

Webhooks

Subscription Event Types

1. subscription.active — Subscription이 활성화됨
2. subscription.updated — Subscription의 field가 변경됨
3. subscription.on_hold — renewal 또는 plan-change charge가 실패함
4. subscription.failed — Subscription 생성에 실패함(최종 상태이며 고객이 다시 subscribe해야 함)
5. subscription.renewed — recurring charge가 성공함
6. subscription.past_due — renewal이 실패하고 grace period가 시작됨. 고객은 past_due_ends_at까지 access를 유지함
7. subscription.plan_changed — Plan이 upgrade, downgrade 또는 변경됨
8. subscription.cancelled — Subscription이 취소됨
9. subscription.expired — Subscription이 term 종료에 도달함

Payment Scenarios

1. subscription.active: mandate가 인증되고 subscription이 활성화됩니다.
2. payment.succeeded: 첫 번째 charge를 확인합니다. checkout 후 2~10분 이내에 수신될 것으로 예상하세요.

1. trial 시작 시(checkout): payment method가 인증되면 subscription.active가 발생합니다. 아직 recurring charge는 청구되지 않습니다. 첫 번째 실제 charge는 trial 종료 시점까지 연기됩니다.
2. trial 종료 시: 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 - payment 실패를 나타냅니다.

2. Subscription On Hold

• subscription.on_hold - renewal payment 또는 plan change charge 실패로 Subscription이 on hold 상태가 됩니다. 비즈니스에 grace period가 있는 경우, renewal 실패 시 먼저 Subscription이 past_due(subscription.past_due)로 이동하며, grace period가 종료될 때에만 on_hold(또는 grace period 설정에 따라 cancelled)로 이동합니다. Subscription States를 참조하세요.
• Subscription이 on hold 상태가 되면 payment method가 업데이트될 때까지 자동으로 renewal되지 않습니다.

subscription.failed vs. subscription.on_hold

Handling Subscription On Hold

When Subscriptions Go On Hold

• Renewal payment 실패: 자금 부족, 만료된 카드 또는 bank decline으로 automatic renewal charge가 실패함
• Plan change charge 실패: plan upgrade/downgrade 중 즉시 charge가 실패함
• Payment method authorization 실패: recurring charge에 대해 payment method를 인증할 수 없음

Reactivating Subscriptions from On Hold

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

Sample Subscription Event Payload

Changing Subscription Plans

Proration Options

1. prorated_immediately

• 남은 시간을 기준으로 prorate하여 현재 billing cycle의 사용하지 않은 부분을 credit으로 제공합니다. 이 credit에는 base plan, quantity 및 add-on이 반영됩니다.
• 그런 다음 새 plan, quantity 및 add-on에 대해 전체 cycle을 청구합니다. charge 자체는 절대 prorate되지 않습니다.
• 순 즉시 charge = (새 전체 cycle) - (남은 비율 x 기존 전체 cycle). credit이 더 큰 경우 차액은 subscription-scoped credit으로 보관되어 향후 renewal에 사용됩니다.
• trial period 중에는 사용자가 즉시 새 plan으로 전환되고 고객에게 바로 charge됩니다.

2. full_immediately

• 이전 cycle에 대한 credit 없이 새 plan의 전체 subscription amount를 고객에게 청구합니다.
• upgrade와 downgrade 모두 고객은 새 plan의 전체 가격을 처음부터 지불합니다.
• 기존 plan에 남은 기간과 관계없이 전체 금액을 청구하려는 경우 유용합니다.

3. difference_immediately

• 고객은 기존 plan 가격과 새 plan 가격의 차액만 지불합니다.
• 금액은 cycle 중 언제 변경하는지에 따라 달라지지 않습니다. 1일 차와 29일 차의 동일한 upgrade 비용은 같습니다.
• upgrade 시 고객에게 차액이 즉시 청구됩니다. 예: $30/month → $80/month = 즉시 $50 청구
• downgrade 시 가격 차액은 subscription-scoped credit으로 저장되어 향후 renewal에 자동 적용됩니다. 예: $50/month → $20/month = $30이 credit으로 저장

4. do_not_bill

• plan 변경을 즉시 적용하지만 변경 시점에는 아무것도 청구하지 않습니다. 새 plan, quantity 및 add-on을 즉시 사용할 수 있습니다.
• 현재 청구 cycle의 남은 기간 동안 upgrade된 상위 plan을 무료로 제공하게 됩니다. downgrade는 이미 결제한 cycle의 미사용 부분에 대한 credit 없이 즉시 적용됩니다.
• do_not_bill를 통해 부여된 add-on은 청구된 적이 없으므로 이후 plan 변경 시 credit되지 않습니다. 이후 변경 시 새 add-on quantity 전체가 청구됩니다.
• 업데이트된 plan(및 quantity/add-on)은 다음 예정 renewal에 청구되며, 기존 billing date는 유지됩니다.

Behavior

• 이 API를 호출하면 Dodo Payments가 선택한 proration option에 따라 즉시 charge를 시작합니다.
• prorated_immediately를 사용하면 upgrade 또는 downgrade에 관계없이 변경할 때마다 현재 cycle의 미사용 부분에 대한 credit이 계산됩니다. 이 credit이 새 cycle charge를 초과하면 나머지가 subscription의 credit balance에 추가됩니다. 이 credit은 해당 subscription에만 적용되며 동일한 subscription의 향후 recurring payment를 상쇄하는 데만 사용됩니다.
• difference_immediately를 사용하면 순액은 항상 정확한 가격 차액입니다. downgrade의 초과분은 prorated_immediately와 동일하게 subscription-scoped credit으로 저장됩니다.
• full_immediately option은 credit 계산을 건너뛰고 새 plan의 전체 amount를 청구합니다.
• do_not_bill option은 변경을 즉시 적용하지만 billing을 다음 renewal date까지 연기하며, 해당 date는 유지됩니다.

Charge Processing

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

On-Demand Subscriptions

Subscription Billing에 대해 알아야 할 주요 사항

Related API Reference