Chuyển đến nội dung chính
POST
/
subscriptions
/
{subscription_id}
/
change-plan
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

await client.subscriptions.changePlan('subscription_id', {
  product_id: 'product_id',
  proration_billing_mode: 'prorated_immediately',
  quantity: 0,
});

​
Thay đổi kế hoạch đã lên lịch

Sử dụng tham số effective_at để kiểm soát khi nào thay đổi kế hoạch có hiệu lực:
Giá trịHành vi
immediatelyÁp dụng thay đổi kế hoạch ngay lập tức. Đây là mặc định.
next_billing_dateLên lịch thay đổi vào ngày lập hóa đơn tiếp theo. Khách hàng giữ quyền truy cập vào kế hoạch hiện tại cho đến khi kết thúc chu kỳ thanh toán.
Thay đổi kế hoạch đã lên lịch là lý tưởng cho việc hạ cấp — khách hàng giữ quyền lợi kế hoạch hiện tại cho đến cuối chu kỳ thanh toán, sau đó tự động chuyển sang kế hoạch mới.
Để hủy thay đổi kế hoạch đã lên lịch trước khi có hiệu lực, sử dụng endpoint Cancel Scheduled Plan Change.

​
Xử lý lỗi thanh toán

Sử dụng tham số on_payment_failure để kiểm soát điều gì xảy ra khi thanh toán thay đổi kế hoạch thất bại:
Giá trịHành vi
prevent_changeGiữ đăng ký trên kế hoạch hiện tại cho đến khi thanh toán thành công. Thay đổi kế hoạch vẫn đang chờ xử lý.
apply_changeÁp dụng thay đổi kế hoạch ngay lập tức bất kể kết quả thanh toán. Đây là mặc định.
Nếu on_payment_failure không được chỉ định, hành vi sẽ mặc định theo cấu hình cấp doanh nghiệp của bạn trong bảng điều khiển.

​
Mã giảm giá

Bạn có thể áp dụng mã giảm giá khi thay đổi kế hoạch bằng cách truyền tham số discount_code.
Kịch bảnHành vi
discount_code được cung cấpXác thực và áp dụng giảm giá cho kế hoạch mới.
discount_code không được cung cấp, mã giảm hiện tại với preserve_on_plan_change=trueGiảm giá hiện tại được duy trì nếu áp dụng cho sản phẩm mới.
discount_code không được cung cấp, không có mã giảm giá nào có thể duy trìKhông áp dụng giảm giá nào.
Sử dụng mã giảm giá trong quá trình thay đổi kế hoạch để cung cấp giá khuyến mại cho việc nâng cấp, hoặc truyền mã khi chuyển khách hàng sang một cấp kế hoạch mới.
Sử dụng prevent_change cho những nâng cấp quan trọng mà bạn muốn đảm bảo thanh toán trước khi cấp quyền truy cập vào các tính năng cao cấp.

Ủy quyền

​
Authorization
string
header
bắt buộc

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Tham số đường dẫn

​
subscription_id
string
bắt buộc

Subscription Id

Nội dung

application/json
​
product_id
string
bắt buộc

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
bắt buộc

Proration Billing Mode

Tùy chọn có sẵn:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
​
quantity
integer<int32>
bắt buộc

Number of units to subscribe for. Must be at least 1.

Phạm vi bắt buộc: x >= 0
​
addons
Attach Addon Request · object[] | null

Addons for the new plan. Note : Leaving this empty would remove any existing addons

​
discount_code
string | null

Optional discount code to apply to the new plan. If provided, validates and applies the discount to the plan change. If not provided and the subscription has an existing discount with preserve_on_plan_change=true, the existing discount will be preserved (if applicable to the new product).

​
effective_at
enum<string>

When to apply the plan change.

  • immediately (default): Apply the plan change right away
  • next_billing_date: Schedule the change for the next billing date
Tùy chọn có sẵn:
immediately,
next_billing_date
​
metadata
object

Metadata for the payment. If not passed, the metadata of the subscription will be taken

​
on_payment_failure
null | enum<string>

Controls behavior when the plan change payment fails.

  • prevent_change: Keep subscription on current plan until payment succeeds
  • apply_change (default): Apply plan change immediately regardless of payment outcome

If not specified, uses the business-level default setting.

Tùy chọn có sẵn:
prevent_change,
apply_change

Phản hồi

Subscription plan changed. If on_payment_failure=prevent_change, the plan change is pending until payment succeeds.

Last modified on April 20, 2026