الانتقال إلى المحتوى الرئيسي
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.