サブスクリプション統合ガイド

​

前提条件

• Dodo Paymentsのマーチャントアカウント
• ダッシュボードからのAPI認証情報（APIキーとWebhookシークレットキー）

​

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

​

Webhook

​

サブスクリプションイベントタイプ

1. subscription.active - サブスクリプションが正常に有効化されました。
2. subscription.updated - サブスクリプションオブジェクトが更新されました（任意のフィールドが変更されたときに発火します）。
3. subscription.on_hold - 更新失敗によりサブスクリプションが保留されました。
4. subscription.failed - マンダート作成中にサブスクリプションの作成が失敗しました。
5. subscription.renewed - 次回請求期間に向けてサブスクリプションが更新されました。

​

支払いシナリオ

1. subscription.active: mandate が承認され、subscription が有効化されます。
2. payment.succeeded: 初回 charge を確認します。checkout から 2〜10 分以内 に発生します。

1. trial 開始時（checkout）: 支払い方法が承認されると subscription.active が 1 回発生します。この時点では定期 charge は発生しません。 初回の実際の charge は trial 終了まで延期されます。
2. trial 終了時: 定期金額が charge され、payment.succeeded と同時に subscription.renewed を受信します。

• subscription.renewed: 更新 payment が引き落とされる各 billing cycle で発生し、常に 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 になります。
• subscription が on hold になると、payment method が更新されるまで自動的には更新されません。

​

subscription.failed と subscription.on_hold の違い

​

Subscription On Hold の処理

​

Subscription が On Hold になる場合

• Renewal payment の失敗: 残高不足、カードの有効期限切れ、または bank decline により、自動 renewal charge に失敗した場合
• Plan change charge の失敗: plan の upgrade/downgrade 中に発生する即時 charge に失敗した場合
• Payment method の承認失敗: recurring charge に対して payment method を承認できない場合

​

On Hold の Subscription を再有効化する

1. 未払い残額に対する charge を作成
2. charge の invoice を生成
3. 新しい payment method を使用して payment を処理
4. payment が成功すると、subscription を active state に再有効化

// 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, {
  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,
    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, {
  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 Options

​

1. prorated_immediately

• 現在の billing cycle の残り時間に基づいて prorated amount を計算
• old plan と new plan の差額のみを customer に charge
• trial 期間中は user を直ちに new plan に切り替え、customer に即時 charge

​

2. full_immediately

• new plan の subscription amount 全額を customer に charge
• previous plan の残り時間や credit を無視
• billing cycle を reset したい場合や、proration に関係なく全額を charge したい場合に便利

​

3. difference_immediately

• upgrade すると、2 つの plan amount の差額が customer に即時 charge されます。
• たとえば、current plan が 30 Dollars で customer が 80 Dollars の plan に upgrade すると、$50 が即時に charge されます。
• downgrade すると、current plan の未使用 amount が internal credit として追加され、今後の subscription renewal に自動的に適用されます。
• たとえば、current plan が 50 Dollars で customer が 20 Dollars の plan に切り替えると、残りの $30 が credit として付与され、次の billing cycle に使用されます。

​

4. do_not_bill

• plan change を即時に適用しますが、変更時には 何も charge しません。
• 更新後の plan（および quantity/add-ons）は次回予定されている renewalで請求され、元の billing date は維持されます。

​

Behavior

• この API を呼び出すと、Dodo Payments は選択した proration option に基づいて直ちに charge を開始します
• plan change が downgrade で、prorated_immediately を使用した場合、credit が自動的に計算され、subscription の credit balance に追加されます。これらの credit はその subscription 専用であり、同じ subscription の今後の recurring payment の offset にのみ使用されます
• full_immediately option は credit の計算を bypass し、新しい plan の金額全額を charge します

​

Charge Processing

• plan change 時に開始される即時 charge は、通常 2 分未満で処理が完了します
• この即時 charge が何らかの理由で失敗すると、問題が解決するまで subscription は自動的に on hold になります

​

On-Demand Subscriptions

​

Subscription Billing について知っておくべき重要事項

​

Related API Reference