メインコンテンツへスキップ
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.