プランの変更
既存のサブスクリプションのプランを変更し、異なる料金ティアへのアップグレードとダウングレードの両方を可能にします。
注: デフォルトでは、顧客が既に登録している支払い情報が使用されます。ホスト型チェックアウトページ経由で請求するには、collect_via_payment_link を設定してください。
スケジュールされたプラン変更
プラン変更の有効化タイミングをコントロールするには、effective_at パラメーターを使用します。
支払い失敗処理
プラン変更の支払いが失敗した場合の処理をコントロールするには、on_payment_failure パラメーターを使用します。
on_payment_failure が指定されない場合、挙動はダッシュボードで設定したビジネスレベルの設定がデフォルトになります。Payment Link 経由での回収
保存済みの支払い方法に請求する代わりに、顧客をホスト型チェックアウトページへ移動させるには、collect_via_payment_link を true に設定します。レスポンスには payment_id、payment_link、client_secret、expires_on が含まれるため、支払いを完了するには顧客を payment_link にリダイレクトします。
以下が必要です:
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 を返します。
保留中の Payment Link の置き換え
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 はキャンセルされます。
Discount Codes
discount_codes array(最大 20 件、array の順序で適用)を渡すことで、プラン変更時に 1 つ以上の stacked discount codes を適用できます。単数形の discount_code field は deprecated ですが、既存の integration では引き続き機能します。同じ request で discount_codes と組み合わせることはできません。
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
パスパラメータ
Subscription Id
ボディ
Unique identifier of the product to subscribe to
Proration Billing Mode
prorated_immediately, full_immediately, difference_immediately, do_not_bill, prorated_immediately_keep_cycle Number of units to subscribe for. Must be at least 1.
x >= 0Whether 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 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.
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.
DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.
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.
When to apply the plan change.
immediately(default): Apply the plan change right awaynext_billing_date: Schedule the change for the next billing date
immediately, next_billing_date Metadata for the payment. If not passed, the metadata of the subscription will be taken
Controls behavior when the plan change payment fails.
prevent_change: Keep subscription on current plan until payment succeedsapply_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 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.