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,
});

​
Xử lý thất bại thanh toán

Sử dụng tham số on_payment_failure để kiểm soát những gì xảy ra khi thanh toán thay đổi gói thất bại:
Giá trịHành vi
prevent_changeGiữ đăng ký ở gói hiện tại cho đến khi thanh toán thành công. Việc thay đổi gói sẽ vẫn đang chờ xử lý.
apply_changeÁp dụng thay đổi gói 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ài đặt cấp doanh nghiệp của bạn được cấu hình trong bảng điều khiển.
Sử dụng prevent_change cho các nâng cấp quan trọng nơi bạn muốn đảm bảo thanh toán trước khi cấp quyền truy cập 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
​
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).

​
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.