跳转到主要内容
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,
});

​
付款失败处理

使用 on_payment_failure 参数来控制计划变更付款失败时的处理方式：
值行为
prevent_change在付款成功之前保持订阅在当前计划上。计划变更保持待定状态。
apply_change无论付款结果如何立即应用计划变更。这是默认行为。
如果未指定 on_payment_failure，则行为默认取决于仪表板中配置的业务级设置。
在需要确保付款后再授予高级功能访问权限的重要升级场景中使用 prevent_change。

授权

​
Authorization
string
header
必填

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

路径参数

​
subscription_id
string
必填

Subscription Id

请求体

application/json
​
product_id
string
必填

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
必填

Proration Billing Mode

可用选项:
prorated_immediately,
full_immediately,
difference_immediately
​
quantity
integer<int32>
必填

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

必填范围: 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.

可用选项:
prevent_change,
apply_change

响应

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