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

​

Xem trước Thay đổi Kế hoạch

const preview = await client.subscriptions.previewChangePlan('sub_123', {
  product_id: 'prod_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="prod_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)

​

API Thay đổi Kế hoạch

​

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() {
  const result = await client.subscriptions.changePlan('sub_123', {
    product_id: 'prod_new',
    quantity: 3,
    proration_billing_mode: 'prorated_immediately',
    on_payment_failure: 'prevent_change', // Optional: control behavior on payment failure
  });
  console.log(result.status, result.invoice_id, result.payment_id);
}

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

result = client.subscriptions.change_plan(
    subscription_id="sub_123",
    product_id="prod_new",
    quantity=3,
    proration_billing_mode="prorated_immediately",
    on_payment_failure="prevent_change",  # Optional: control behavior on payment failure
)
print(result.status, result.get("invoice_id"), result.get("payment_id"))

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"))
  res, err := client.Subscriptions.ChangePlan(context.TODO(), dodopayments.SubscriptionChangePlanParams{
    SubscriptionID: dodopayments.F("sub_123"),
    ProductID:             dodopayments.F("prod_new"),
    Quantity:              dodopayments.F(int64(3)),
    ProrationBillingMode:  dodopayments.F(dodopayments.SubscriptionChangePlanParamsProrationBillingModeProratedImmediately),
    OnPaymentFailure:      dodopayments.F(dodopayments.OnPaymentFailurePreventChange), // Optional
  })
  if err != nil { panic(err) }
  fmt.Println(res.Status, res.InvoiceID, res.PaymentID)
}

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": "prod_new",
    "quantity": 3,
    "proration_billing_mode": "prorated_immediately",
    "on_payment_failure": "prevent_change"
  }'

{
  "status": "processing",
  "subscription_id": "sub_123",
  "invoice_id": "inv_789",
  "payment_id": "pay_456",
  "proration_billing_mode": "prorated_immediately"
}

​

Quản lý Addons

// Add addons to the new plan
await client.subscriptions.changePlan('sub_123', {
  product_id: 'prod_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: 'prod_new',
  quantity: 1,
  proration_billing_mode: 'difference_immediately',
  addons: [] // Empty array removes all existing addons
});

​

Áp dụng Mã Giảm Giá

// Apply a discount code during plan change
await client.subscriptions.changePlan('sub_123', {
  product_id: 'prod_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately',
  discount_code: 'UPGRADE20'
});

# Apply a discount code during plan change
client.subscriptions.change_plan(
    subscription_id="sub_123",
    product_id="prod_pro",
    quantity=1,
    proration_billing_mode="prorated_immediately",
    discount_code="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": "prod_pro",
    "quantity": 1,
    "proration_billing_mode": "prorated_immediately",
    "discount_code": "UPGRADE20"
  }'

​

Hành vi mã giảm giá khi thay đổi kế hoạch

​

Chế độ tính tỷ lệ

​

prorated_immediately

• Tính phí cho sự chênh lệch phần còn lại trong chu kỳ hiện tại
• Nếu đang trong giai đoạn thử nghiệm, tính phí ngay và chuyển sang gói mới ngay lập tức
• Hạ cấp: có thể tạo ra một khoản tín dụng tỷ lệ áp dụng cho các gia hạn tương lai

​

full_immediately

• Tính phí đầy đủ cho gói mới ngay lập tức
• Bỏ qua thời gian còn lại từ gói cũ

​

difference_immediately

• Nâng cấp: tính phí ngay lập tức chênh lệch giá giữa gói cũ và mới
• Hạ cấp: thêm giá trị còn lại dưới dạng tín dụng nội bộ vào gói đăng ký và tự động áp dụng cho các lần gia hạn

​

do_not_bill

• Không tính phí hoặc tín dụng
• Khách hàng chuyển ngay sang gói mới mà không cần điều chỉnh thanh toán
• Chu kỳ thanh toán không thay đổi
• Tốt cho các lần di chuyển lịch sự, chuyển đổi gói miễn phí, hoặc hấp thụ chênh lệch chi phí

​

Kịch bản ví dụ

• Gói hiện tại: Basic với $30/tháng
• Mục tiêu nâng cấp: Pro với $80/tháng
• Mục tiêu hạ cấp (từ Pro): Starter với $20/tháng
• Chu kỳ thanh toán: 30 ngày, bắt đầu vào ngày 1 tháng 1
• Thay đổi kế hoạch diễn ra vào ngày 16 tháng 1 (15 ngày còn lại, 15 ngày đã sử dụng)

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
→ Next renewal (Feb 1): $80.00/month

await client.subscriptions.changePlan('sub_123', {
  product_id: 'prod_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
→ Credit auto-applies to future renewals
→ Next renewal (Feb 1): $20.00 − $30.00 credit = $0.00
→ Following renewal (Mar 1): $20.00 − $10.00 remaining credit = $10.00

await client.subscriptions.changePlan('sub_123', {
  product_id: 'prod_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)
→ Next renewal (Feb 1): $80.00/month

await client.subscriptions.changePlan('sub_123', {
  product_id: 'prod_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: 'prod_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: 'prod_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: 'prod_pro',
  quantity: 1,
  proration_billing_mode: 'prorated_immediately',
  addons: [
    { addon_id: 'addon_seats', quantity: 3 }
  ]
})

​

Cách mỗi chế độ xử lý thanh toán

​

Xử lý sự cố Thanh toán

​

Chế độ Xử lý Sự cố Thanh toán

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

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

​

Khi nào nên Sử dụng Mỗi Chế độ

​

Xử lý webhook

​

Các loại sự kiện cần xử lý

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

​

Xác nhận chữ ký và xử lý ý định

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 Thực tiễn Tốt nhất

​

Chiến lược Thay đổi Kế hoạch

• Kiểm tra kỹ lưỡng: Luôn kiểm tra các thay đổi kế hoạch trong chế độ kiểm tra trước khi triển khai vào sản xuất
• Chọn chế độ tỷ lệ cẩn thận: Chọn chế độ tỷ lệ phù hợp với mô hình kinh doanh của bạn
• Xử lý lỗi một cách linh hoạt: Triển khai xử lý lỗi đúng cách và logic thử lại
• Giám sát tỷ lệ thành công: Theo dõi tỷ lệ thành công/thất bại của thay đổi kế hoạch và điều tra các vấn đề

​

Triển khai Webhook

• Xác nhận 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ý các sự kiện webhook trùng lặp một cách linh hoạt
• Xử lý không đồng bộ: Không chặn phản hồi webhook với các hoạt động nặng
• Ghi đè mọi thứ: Duy trì log chi tiết để gỡ lỗi và kiểm toán

​

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

• Giao tiếp rõ ràng: Thông báo cho khách hàng về các thay đổi thanh toán và thời gian
• Cung cấp xác nhận: Gửi email xác nhận cho những thay đổi kế hoạch thành công
• Xử lý các trường hợp biên: Xem xét thời gian thử nghiệm, các tỷ lệ và thanh toán thất bại
• Cập nhật giao diện ngay lập tức: Phản ánh các thay đổi kế hoạch trong giao diện ứng dụng của bạn

​

Các sự cố Phổ biến 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, {
    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, {
    type: 'existing',
    payment_method_id: paymentMethodId
  });
  
  // Monitor webhooks for payment.succeeded and subscription.active
  return response;
}

​

Thử nghiệm Triển khai của Bạn

​

Xử lý Lỗi

​

Mã Trạng thái HTTP

​

Định dạng Phản hồi Lỗi

{
  "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 API Thay đổi Kế hoạch
• Khám phá Thanh toán Dựa trên Tín dụng
• Triển khai cảnh báo cho subscription.on_hold
• Xem hướng dẫn Tích hợp Webhook