Subscription Upgrade & Downgrade Guide

​

What is a subscription upgrade or downgrade?

• Align pricing with usage or features
• Move from monthly to annual (or vice versa)
• Adjust quantity for seat-based products

​

When to use plan changes

• Upgrade when a customer needs more features, usage, or seats
• Downgrade when usage decreases
• Migrate users to a new product or price without cancelling their subscription

​

Plan Change Flow

​

Prerequisites

• A Dodo Payments merchant account with active subscription products
• API credentials (API key and webhook secret key) from the dashboard
• An existing active subscription to modify
• Webhook endpoint configured to handle subscription events

​

Step-by-Step Implementation Guide

​

Preview thay đổi gói

const preview = await client.subscriptions.previewChangePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately'
});

// Show customer the charge before confirming
console.log('Immediate charge:', preview.immediate_charge.summary);
console.log('New plan details:', preview.new_plan);

preview = client.subscriptions.preview_change_plan(
    subscription_id="sub_123",
    product_id="pdt_pro",
    quantity=1,
    proration_billing_mode="prorated_immediately"
)

# Show customer the charge before confirming
print("Immediate charge:", preview.immediate_charge.summary)
print("New plan details:", preview.new_plan)

​

Change Plan API

​

Ví dụ bắt đầu nhanh

import DodoPayments from 'dodopayments';

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

async function changePlan() {
  // change-plan returns 200 with an empty body.
  await client.subscriptions.changePlan('sub_123', {
    product_id: 'pdt_new',
    quantity: 3,
    proration_billing_mode: 'prorated_immediately',
    on_payment_failure: 'prevent_change', // Optional: control behavior on payment failure
  });
  console.log('Plan change accepted; awaiting webhooks');
}

changePlan();

import os
from dodopayments import DodoPayments

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

# change_plan returns 200 with an empty body.
client.subscriptions.change_plan(
    subscription_id="sub_123",
    product_id="pdt_new",
    quantity=3,
    proration_billing_mode="prorated_immediately",
    on_payment_failure="prevent_change",  # Optional: control behavior on payment failure
)
print("Plan change accepted; awaiting webhooks")

package main

import (
  "context"
  "fmt"
  "github.com/dodopayments/dodopayments-go"
  "github.com/dodopayments/dodopayments-go/option"
)

func main() {
  client := dodopayments.NewClient(option.WithBearerToken("YOUR_TOKEN"))
  // ChangePlan returns no response body; a nil error means the change succeeded.
  err := client.Subscriptions.ChangePlan(context.TODO(), "sub_123", dodopayments.SubscriptionChangePlanParams{
    UpdateSubscriptionPlanReq: dodopayments.UpdateSubscriptionPlanReqParam{
      ProductID:            dodopayments.F("pdt_new"),
      Quantity:             dodopayments.F(int64(3)),
      ProrationBillingMode: dodopayments.F(dodopayments.UpdateSubscriptionPlanReqProrationBillingModeProratedImmediately),
      OnPaymentFailure:     dodopayments.F(dodopayments.UpdateSubscriptionPlanReqOnPaymentFailurePreventChange), // Optional
    },
  })
  if err != nil { panic(err) }
  fmt.Println("Plan change applied")
}

curl -X POST "$DODO_API_BASE/subscriptions/sub_123/change-plan" \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "pdt_new",
    "quantity": 3,
    "proration_billing_mode": "prorated_immediately",
    "on_payment_failure": "prevent_change"
  }'

​

Thu tiền qua Checkout Link

​

Yêu cầu

• Doanh nghiệp đã bật capability allow_plan_change_via_payment_link (Settings → Subscriptions → Collect Plan Change Payments by Payment Link).
• effective_at là immediately (mặc định). Thay đổi theo lịch (next_billing_date) không cần trang checkout vì chỉ tính phí khi thay đổi được áp dụng.
• on_payment_failure hiệu lực phân giải thành prevent_change. Bạn không cần gửi rõ field này — nếu giá trị mặc định cấp doanh nghiệp (xem Business & Collection Defaults bên dưới) đã là prevent_change thì việc bỏ qua field cũng đáp ứng điều kiện. apply_change rõ ràng hoặc giá trị mặc định được phân giải thành apply_change sẽ thất bại với 422.

const response = await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately',
  effective_at: 'immediately',
  on_payment_failure: 'prevent_change',
  collect_via_payment_link: true,
});

// Hand response.payment_link to your frontend and send the customer there
console.log(response.payment_link);

response = client.subscriptions.change_plan(
    subscription_id="sub_123",
    product_id="pdt_pro",
    quantity=1,
    proration_billing_mode="prorated_immediately",
    effective_at="immediately",
    on_payment_failure="prevent_change",
    collect_via_payment_link=True,
)

# Hand response.payment_link to your frontend and send the customer there
print(response.payment_link)

curl -X POST "$DODO_API_BASE/subscriptions/sub_123/change-plan" \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "pdt_pro",
    "quantity": 1,
    "proration_billing_mode": "prorated_immediately",
    "effective_at": "immediately",
    "on_payment_failure": "prevent_change",
    "collect_via_payment_link": true
  }'

{
  "payment_id": "<payment_id>",
  "payment_link": "https://checkout.dodopayments.com/...",
  "client_secret": "<client_secret>",
  "expires_on": "<expires_on>"
}

​

Điều gì xảy ra khi link chưa được thanh toán

• Subscription vẫn giữ gói hiện tại — product_id, recurring_pre_tax_amount và next_billing_date đều không thay đổi cho đến khi link được thanh toán.
• Một request change-plan tiếp theo trên cùng subscription sẽ bị từ chối với 409 PendingPlanChangeExists trong khi link đang chờ xử lý. Nếu cần, hãy hủy thay đổi theo lịch bằng DELETE /subscriptions/{subscription_id}/change-plan/scheduled, nhưng endpoint đó không hủy thay đổi payment-link đang chờ — chỉ thanh toán thành công hoặc hết hạn mới thực hiện việc này.
• Khách hàng có thể thử lại thẻ trong cùng checkout session sau khi bị từ chối; gọi change-plan mới không phải cách retry.
• Nếu link không bao giờ được thanh toán, link sẽ ngừng hoạt động sau expires_on — subscription tự động có thể nhận request thay đổi gói mới sau đó không lâu.
• Nếu đã có thay đổi theo lịch (next_billing_date) và bạn thay thế bằng cancel_scheduled_change_plan: true, lịch ban đầu vẫn được giữ trong khi link chưa được thanh toán và chỉ bị hủy sau khi link được thanh toán — trong cùng transaction áp dụng gói mới.

​

Quản lý Addon

// Add addons to the new plan
await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_new',
  quantity: 1,
  proration_billing_mode: 'difference_immediately',
  addons: [
    { addon_id: 'addon_123', quantity: 2 }
  ]
});

// Remove all existing addons
await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_new',
  quantity: 1,
  proration_billing_mode: 'difference_immediately',
  addons: [] // Empty array removes all existing addons
});

​

Áp dụng mã giảm giá

// Apply stacked discount codes during plan change
await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately',
  discount_codes: ['UPGRADE20']
});

# Apply stacked discount codes during plan change
client.subscriptions.change_plan(
    subscription_id="sub_123",
    product_id="pdt_pro",
    quantity=1,
    proration_billing_mode="prorated_immediately",
    discount_codes=["UPGRADE20"]
)

curl -X POST "$DODO_API_BASE/subscriptions/sub_123/change-plan" \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "pdt_pro",
    "quantity": 1,
    "proration_billing_mode": "prorated_immediately",
    "discount_codes": ["UPGRADE20"]
  }'

​

Hành vi của discount khi thay đổi gói

​

Các proration mode

​

prorated_immediately

• Tính phí phần chênh lệch theo tỷ lệ trong chu kỳ hiện tại
• Nếu đang trial, tính phí ngay và chuyển sang gói mới ngay
• Hạ cấp: có thể tạo credit theo tỷ lệ, áp dụng cho các lần gia hạn sau

​

full_immediately

• Tính toàn bộ giá của gói mới ngay lập tức
• Bỏ qua thời gian còn lại của gói cũ

​

difference_immediately

• Nâng cấp: tính ngay khoản chênh lệch giá giữa gói cũ và gói mới
• Hạ cấp: cộng giá trị còn lại thành credit nội bộ cho subscription và tự động áp dụng khi gia hạn

​

do_not_bill

• Không tính toán khoản phí hoặc credit nào
• Khách hàng chuyển sang gói mới ngay lập tức mà không điều chỉnh billing
• Chu kỳ billing không thay đổi
• Phù hợp nhất cho migration hỗ trợ, chuyển sang gói miễn phí hoặc hấp thụ phần chênh lệch chi phí

​

Các tình huống ví dụ

• Gói hiện tại: Basic ở mức $30/tháng
• Gói mục tiêu khi nâng cấp: Pro ở mức $80/tháng
• Gói mục tiêu khi hạ cấp (từ Pro): Starter ở mức $20/tháng
• Chu kỳ billing: 30 ngày, bắt đầu từ January 1
• Thay đổi gói diễn ra vào January 16 (còn 15 ngày, đã sử dụng 15 ngày)

Step 1: Calculate unused credit from current plan
  Unused days = 15 out of 30 days
  Credit = $30 × (15/30) = $15.00

Step 2: Calculate prorated cost of new plan
  Remaining days = 15 out of 30 days
  New plan cost = $80 × (15/30) = $40.00

Step 3: Calculate immediate charge
  Charge = New plan cost − Credit
  Charge = $40.00 − $15.00 = $25.00

→ Customer pays $25.00 now
→ Billing cycle resets to today (January 16)
→ Next renewal (Feb 15): $80.00/month

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately'
})

Step 1: Calculate unused credit from current plan
  Unused days = 15 out of 30 days
  Credit = $80 × (15/30) = $40.00

Step 2: Calculate prorated cost of new plan
  Remaining days = 15 out of 30 days
  New plan cost = $20 × (15/30) = $10.00

Step 3: Calculate credit balance
  Credit = $40.00 − $10.00 = $30.00

→ No charge — $30.00 credit added to subscription
→ Billing cycle resets to today (January 16)
→ Credit auto-applies to future renewals
→ Next renewal (Feb 15): $20.00 − $20.00 (from credit) = $0.00 ($10.00 credit remaining)
→ Following renewal (Mar 15): $20.00 − $10.00 remaining credit = $10.00

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_starter',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately'
})

Immediate charge = New plan price − Old plan price
                 = $80 − $30
                 = $50.00

→ Customer pays $50.00 now (regardless of cycle position)
→ Billing cycle resets to today (January 16)
→ Next renewal (Feb 15): $80.00/month

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'difference_immediately'
})

Credit = Old plan price − New plan price
       = $80 − $20
       = $60.00

→ No charge — $60.00 credit added to subscription
→ Credit auto-applies to future renewals
→ Next renewal: $20.00 − $20.00 (from credit) = $0.00
→ Following renewal: $20.00 − $20.00 (from credit) = $0.00
→ Third renewal: $20.00 − $20.00 (from remaining credit) = $0.00

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_starter',
  quantity: 1,
  proration_billing_mode: 'difference_immediately'
})

Immediate charge = Full new plan price = $80.00

→ Customer pays $80.00 now
→ No credit for unused time on old plan
→ Billing cycle resets to today (January 16)
→ Next renewal: February 16 at $80.00/month

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'full_immediately'
})

Current: Basic plan ($30/month), no add-ons
New: Pro plan ($80/month) + Extra Seats add-on ($10/seat × 3 seats = $30/month)
Change on day 16 of 30 (15 days remaining)

Step 1: Credit from current plan
  Credit = $30 × (15/30) = $15.00

Step 2: Prorated cost of new plan + add-ons
  New plan = $80 × (15/30) = $40.00
  Add-ons = $30 × (15/30) = $15.00
  Total new = $55.00

Step 3: Immediate charge
  Charge = $55.00 − $15.00 = $40.00

→ Customer pays $40.00 now
→ Next renewal: $80.00 + $30.00 = $110.00/month

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately',
  addons: [
    { addon_id: 'addon_seats', quantity: 3 }
  ]
})

​

Cách mỗi mode xử lý billing

​

Xử lý lỗi thanh toán

​

Các chế độ lỗi thanh toán

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately',
  on_payment_failure: 'prevent_change'
});

await client.subscriptions.changePlan('sub_123', {
  product_id: 'pdt_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately',
  on_payment_failure: 'apply_change' // This is the default
});

​

Khi nào nên dùng từng mode

​

Mặc định cấp doanh nghiệp & thu tiền

​

Thứ tự phân giải

per-request value (Change Plan API) → collection field (if set) → business field → system default

​

Xử lý webhook

​

Các loại event cần xử lý

• subscription.active: subscription đã được kích hoạt
• subscription.plan_changed: gói subscription đã thay đổi (nâng cấp/hạ cấp/thay đổi addon)
• subscription.on_hold: tính phí thất bại, các lần gia hạn bị dừng
• subscription.renewed: gia hạn thành công
• payment.succeeded: thanh toán cho thay đổi gói hoặc gia hạn thành công
• payment.failed: thanh toán thất bại

​

Xác minh chữ ký và xử lý intent

import { NextRequest, NextResponse } from 'next/server';

export async function POST(req) {
  const webhookId = req.headers.get('webhook-id');
  const webhookSignature = req.headers.get('webhook-signature');
  const webhookTimestamp = req.headers.get('webhook-timestamp');
  const secret = process.env.DODO_WEBHOOK_SECRET;

  const payload = await req.text();
  // verifySignature is a placeholder – in production, use a Standard Webhooks library
  const { valid, event } = await verifySignature(
    payload,
    { id: webhookId, signature: webhookSignature, timestamp: webhookTimestamp },
    secret
  );
  if (!valid) return NextResponse.json({ error: 'Invalid signature' }, { status: 400 });

  switch (event.type) {
    case 'subscription.active':
      // mark subscription active in your DB
      break;
    case 'subscription.plan_changed':
      // refresh entitlements and reflect the new plan in your UI
      break;
    case 'subscription.on_hold':
      // notify user to update payment method
      break;
    case 'subscription.renewed':
      // extend access window
      break;
    case 'payment.succeeded':
      // reconcile payment for plan change
      break;
    case 'payment.failed':
      // log and alert
      break;
    default:
      // ignore unknown events
      break;
  }

  return NextResponse.json({ received: true });
}

import express from 'express';

const app = express();
app.post('/webhooks/dodo', express.raw({ type: 'application/json' }), async (req, res) => {
  const webhookId = req.header('webhook-id');
  const webhookSignature = req.header('webhook-signature');
  const webhookTimestamp = req.header('webhook-timestamp');
  const secret = process.env.DODO_WEBHOOK_SECRET;
  const payload = req.body.toString('utf8');

  const { valid, event } = await verifySignature(
    payload,
    { id: webhookId, signature: webhookSignature, timestamp: webhookTimestamp },
    secret
  );
  if (!valid) return res.status(400).send('Invalid signature');

  // handle events like above
  res.json({ received: true });
});

app.listen(3000);

​

Các phương pháp hay nhất

​

Chiến lược thay đổi gói

• Kiểm thử kỹ lưỡng: Luôn kiểm thử thay đổi gói ở test mode trước khi đưa lên production
• Lựa chọn proration cẩn thận: Chọn proration mode phù hợp với mô hình kinh doanh
• Xử lý lỗi phù hợp: Triển khai error handling và retry logic thích hợp
• Theo dõi tỷ lệ thành công: Theo dõi tỷ lệ thay đổi gói thành công/thất bại và điều tra vấn đề

​

Triển khai webhook

• Xác minh chữ ký: Luôn xác thực chữ ký webhook để đảm bảo tính xác thực
• Triển khai idempotency: Xử lý phù hợp các event webhook trùng lặp
• Xử lý bất đồng bộ: Không chặn response webhook bằng các thao tác nặng
• Ghi log mọi thứ: Duy trì log chi tiết để debug và kiểm toán

​

Trải nghiệm người dùng

• Trao đổi rõ ràng: Thông báo cho khách hàng về các thay đổi billing và thời điểm áp dụng
• Cung cấp xác nhận: Gửi email xác nhận khi thay đổi gói thành công
• Xử lý trường hợp đặc biệt: Cân nhắc thời gian trial, proration và các khoản thanh toán thất bại
• Cập nhật UI ngay lập tức: Phản ánh thay đổi gói trong giao diện application

​

Các vấn đề thường gặp và giải pháp

// Reactivate subscription from on_hold after failed plan change
async function reactivateAfterFailedPlanChange(subscriptionId) {
  // Update payment method - automatically creates charge for remaining dues
  const response = await client.subscriptions.updatePaymentMethod(subscriptionId, {
    payment_method: { type: 'new', return_url: 'https://example.com/return' }
  });
  
  if (response.payment_id) {
    console.log('Charge created for remaining dues:', response.payment_id);
    console.log('Payment link:', response.payment_link);
    
    // Redirect customer to payment_link to complete payment
    // Monitor webhooks for:
    // 1. payment.succeeded - charge succeeded
    // 2. subscription.active - subscription reactivated
  }
  
  return response;
}

// Or use existing payment method if available
async function reactivateWithExistingPaymentMethod(subscriptionId, paymentMethodId) {
  const response = await client.subscriptions.updatePaymentMethod(subscriptionId, {
    payment_method: { type: 'existing', payment_method_id: paymentMethodId }
  });
  
  // Monitor webhooks for payment.succeeded and subscription.active
  return response;
}

# Reactivate subscription from on_hold after failed plan change
def reactivate_after_failed_plan_change(subscription_id):
    # Update payment method - automatically creates charge for remaining dues
    response = client.subscriptions.update_payment_method(
        subscription_id=subscription_id,
        payment_method={"type": "new", "return_url": "https://example.com/return"},
    )
    
    if response.payment_id:
        print("Charge created for remaining dues:", response.payment_id)
        print("Payment link:", response.payment_link)
        
        # Redirect customer to payment_link to complete payment
        # Monitor webhooks for:
        # 1. payment.succeeded - charge succeeded
        # 2. subscription.active - subscription reactivated
    
    return response

# Or use existing payment method if available
def reactivate_with_existing_payment_method(subscription_id, payment_method_id):
    response = client.subscriptions.update_payment_method(
        subscription_id=subscription_id,
        payment_method={"type": "existing", "payment_method_id": payment_method_id},
    )
    
    # Monitor webhooks for payment.succeeded and subscription.active
    return response

​

Kiểm thử implementation

​

Xử lý lỗi

​

HTTP Status Codes

​

Định dạng error response

{
  "error": {
    "code": "subscription_not_found",
    "message": "The subscription with ID 'sub_123' was not found",
    "details": {
      "subscription_id": "sub_123"
    }
  }
}

​

Bước tiếp theo

• Xem lại Change Plan API
• Tìm hiểu Credit-Based Billing
• Triển khai cảnh báo cho subscription.on_hold
• Xem Webhook Integration Guide