Skip to main content
POST
JavaScript

スケジュールされたプラン変更

プラン変更の有効化タイミングをコントロールするには、effective_at パラメーターを使用します。
スケジュールされたプラン変更はダウングレードに最適です。顧客は請求期間の終了まで現在のプランの特典を保持し、その後自動的に新しいプランに切り替わります。
計画されたプラン変更を有効化前にキャンセルするには、キャンセルスケジュールプラン変更エンドポイントを使用します。

支払い失敗処理

プラン変更の支払いが失敗した場合の処理をコントロールするには、on_payment_failure パラメーターを使用します。
on_payment_failure が指定されない場合、挙動はダッシュボードで設定したビジネスレベルの設定がデフォルトになります。
保存済みの支払い方法に請求する代わりに、顧客をホスト型チェックアウトページへ移動させるには、collect_via_payment_link を true に設定します。レスポンスには payment_id、payment_link、client_secret、expires_on が含まれるため、支払いを完了するには顧客を payment_link にリダイレクトします。 以下が必要です: これらの条件を満たさない request は 422 を返します。link が未払いの間、subscription は現在のプランに留まり、change-plan の追加の request は 409 を返します。ただし、cancel_older_payment_link を設定した場合を除きます。

支払い後の Redirect

支払い後に customer をサイトへ戻すには、return_url を設定します。redirect には、subscription_id、payment_id、status が query parameters として追加されます。
  • status は subscription の status ではなく、plan-change payment の status です。
  • payment が失敗した場合、subscription は現在のプランで active のままです。再試行するには、change-plan を再度呼び出して新しい link を取得します。
  • payment webhook が到着すると、redirect の直後に新しいプランが適用される場合があります。
return_url には collect_via_payment_link: true が必要です。これがない場合、request は 422 を返します。 customer が支払いをせずに checkout を離れた場合、次の change-plan request で cancel_older_payment_link を true に設定します。Dodo Payments は未払いの link をキャンセルし、新しいプラン変更で保留中の変更を置き換えます。キャンセルされた link では、以降 payment を受け付けません。 link がキャンセルされる前に request の validation が行われるため、無効な request の場合は customer の link が維持されます。link がキャンセルされるのは、customer が支払いを開始していない場合のみです。 各 change-plan request では、それぞれ独自の invoice が発行されます。置き換えられたプラン変更とその invoice はキャンセルされます。
declined payment、保留中の link の置き換え、link の有効期限が切れた場合の動作など、完全なフローについては Subscription Upgrade & Downgrade Guide を参照してください。

Discount Codes

discount_codes array(最大 20 件、array の順序で適用)を渡すことで、プラン変更時に 1 つ以上の stacked discount codes を適用できます。単数形の discount_code field は deprecated ですが、既存の integration では引き続き機能します。同じ request で discount_codes と組み合わせることはできません。
プラン変更時に discount codes を使用すると、upgrade にプロモーション価格を提供できます。また、customer を新しいプラン tier に移行する際に codes を渡すこともできます。
プレミアム機能への access を付与する前に payment を確実に行いたい重要な upgrade では、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,
do_not_bill,
prorated_immediately_keep_cycle
quantity
integer<int32>
必須

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

必須範囲: 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

Cancel the payment link of a pending plan change, so that this change can replace it.

The link is cancelled only if the customer has not started to pay. A paid or in-progress payment gives a 409. A failed cancel gives a 503, and a retry is safe.

The request is validated before the cancel. A later failure, for example an amount below the minimum, leaves the subscription on its current plan with no open link. A retry is safe.

The preview route shares this request body and ignores this field.

cancel_scheduled_change_plan
boolean

Replace a scheduled plan change with this one.

The scheduled change is cancelled by the transaction that applies this change. A change that never applies leaves the schedule in place.

effective_at: next_billing_date is allowed. The new schedule then replaces the old one in the request transaction.

A pending plan change still gets a 409. This field does not affect it.

The preview route shares this request body, so a preview that sets this field also passes the scheduled-change 409.

Collect the plan-change amount with a payment link. The customer then pays on a checkout page.

The business needs the allow_plan_change_via_payment_link capability. The request needs effective_at: immediately. The request also needs on_payment_failure: prevent_change.

The preview route shares this request body and ignores this field.

discount_code
string | null
非推奨

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
利用可能なオプション:
immediately,
next_billing_date
metadata
null | 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

With effective_at: next_billing_date, the plan change payment replaces the renewal payment. If that payment fails with prevent_change, the plan change is cancelled. The subscription then renews on the current plan, with the usual payment retries.

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

利用可能なオプション:
prevent_change,
apply_change
return_url
string | null

The URL that receives the customer after they pay the payment link. Needs collect_via_payment_link: true. Without it, the request gets a 422. A change that collects no money issues no link and does not use the URL. The preview route validates this field but does not use it.

The redirect adds subscription_id, payment_id and status. The status value is the status of the plan-change payment. It is not the status of the subscription. When that payment fails, the subscription stays active on its current plan. To try again, call this endpoint again to get a new link. The new plan can apply after the redirect, when the payment webhook arrives.

レスポンス

Subscription plan changed. A link request can return checkout details. A pending plan change applies after payment succeeds.

Handles for a hosted checkout page that settles a plan change.

The four fields repeat UpdatePaymentMethodResponse and a subset of CreateSubscriptionResponse. A shared type would rename the generated SDK types for all three routes, so each route keeps its own.

client_secret
string | null

Client secret for an embedded checkout.

expires_on
string<date-time> | null

When the link stops working.

payment_id
string | null

Id of the payment that settles the plan change.

Checkout page URL. Give this to the customer.

最終更新日 2026年10月8日