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

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

​
تغييرات الخطة المجدولة

استخدم المعامل effective_at للتحكم في موعد تنفيذ تغيير الخطة:
القيمةالسلوك
immediatelyتطبيق تغيير الخطة فورًا. هذا هو الإعداد الافتراضي.
next_billing_dateجدولة التغيير لموعد الفاتورة التالي. يحتفظ العميل بحق الوصول إلى خطته الحالية حتى ينتهي فترة الفوترة.
تعتبر تغييرات الخطة المجدولة مثالية للتخفيضات — يحتفظ العملاء بمزايا خطتهم الحالية حتى نهاية فترة الفوترة، ثم يتم التحويل تلقائيًا إلى الخطة الجديدة.
لإلغاء تغيير خطة مجدولة قبل أن يصبح ساري المفعول، استخدم نقطة النهاية إلغاء تغيير الخطة المجدولة.

​
معالجة فشل الدفع

استخدم المعامل on_payment_failure للتحكم في ما يحدث عندما يفشل دفع تغيير الخطة:
القيمةالسلوك
prevent_changeاحتفظ بالاشتراك على الخطة الحالية حتى يتم النجاح في الدفع. يبقى تغيير الخطة معلقًا.
apply_changeتطبيق تغيير الخطة فورًا بغض النظر عن نتيجة الدفع. هذا هو الإعداد الافتراضي.
إذا لم يتم تحديد on_payment_failure، فإن السلوك الافتراضي يعتمد على إعداد مستوى العمل الخاص بك والمحدد في لوحة التحكم.

​
رموز الخصم

يمكنك تطبيق رمز خصم عند تغيير الخطط بتمرير المعامل discount_code.
السيناريوالسلوك
discount_code مقدمتحقق من صحة الخصم وتطبيقه على الخطة الجديدة.
discount_code غير مقدم، خصم موجود بـ preserve_on_plan_change=trueيتم الاحتفاظ بالخصم الحالي إذا كان قابلاً للتطبيق على المنتج الجديد.
discount_code غير مقدم، لا يوجد خصم صالح للحفظلا يتم تطبيق خصم.
استخدم رموز الخصم أثناء تغييرات الخطة لتقديم تسعير ترويجي على الترقيات، أو تمرير رمز عند ترحيل العملاء إلى فئة خطة جديدة.
استخدم 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
​
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

​
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
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.

Last modified on April 20, 2026