Thay đổi gói

Chỉnh sửa gói của một đăng ký hiện có, cho phép cả việc nâng cấp và hạ cấp xuống các mức giá khác nhau.

Lưu ý: Điều này sẽ sử dụng thông tin thanh toán hiện có của khách hàng để nâng cấp/hạ cấp gói.

POST /subscriptions/{subscription_id}/change-plan

JavaScript

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_date	Lê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_change	Giữ đă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ột hoặc nhiều mã giảm giá xếp chồng khi thay đổi gói bằng cách truyền mảng discount_codes (tối đa 20 mục, áp dụng theo thứ tự của mảng). Trường đơn discount_code đã lỗi thời nhưng vẫn hoạt động cho các tích hợp hiện có; không thể kết hợp với discount_codes trong cùng một yêu cầu.

Giá trị discount_codes	Hành vi
Không được cung cấp (null / bỏ qua)	Các giảm giá hiện có với preserve_on_plan_change=true được giữ nếu áp dụng cho sản phẩm mới.
[] (mảng rỗng)	Tất cả các giảm giá hiện có sẽ bị loại bỏ khỏi đăng ký.
["CODE_A", "CODE_B", ...]	Thay thế bất kỳ giảm giá hiện có nào bằng bộ xếp chồng này, được xác thực và áp dụng theo thứ tự của mảng.

Sử dụng mã giảm giá trong quá trình thay đổi gói để cung cấp giá khuyến mãi khi nâng cấp, hoặc truyền mã khi di chuyển khách hàng sang cấp gói 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

adaptive_currency_fees_inclusive · boolean | null

Whether adaptive currency fees should be included in the price (true) or added on top (false). If not specified, uses the subscription's stored setting.

addons · Attach Addon Request · object[] | null

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

Show child attributes

discount_code · string | null · không còn sử dụng

DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.

discount_codes · string[] | null

Stacked discount codes to apply to the new plan. Max 20. Cannot be used together with discount_code. If provided, replaces any existing discount codes. Empty array removes all discounts. If not provided (None), existing discounts with preserve_on_plan_change=true are preserved.

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

Show child attributes

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

200

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