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 لإكمال عملية الدفع. يتطلب ذلك ما يلي: تُرجع الطلبات التي لا تستوفي هذه الشروط 422. وأثناء عدم دفع قيمة الرابط، يظل الاشتراك على خطته الحالية، ويُرجع أي طلب change-plan لاحقًا 409، ما لم تُعيّن cancel_older_payment_link.

إعادة التوجيه بعد الدفع

عيّن return_url لإعادة العميل إلى موقعك بعد دفع قيمة الرابط. يضيف redirect كلًا من subscription_id وpayment_id وstatus كمعاملات query.
  • يعبّر status عن حالة دفع تغيير الخطة، وليس عن حالة الاشتراك.
  • عند فشل الدفع، يظل الاشتراك نشطًا على خطته الحالية. للمحاولة مرة أخرى، استدعِ change-plan مجددًا للحصول على رابط جديد.
  • يمكن تطبيق الخطة الجديدة بعد redirect بوقت قصير، عند وصول payment webhook.
يتطلب return_url القيمة collect_via_payment_link: true. وبدونها، يُرجع الطلب 422.

استبدال رابط دفع معلّق

إذا غادر العميل checkout دون الدفع، فعيّن cancel_older_payment_link إلى true في طلب change-plan التالي. تلغي Dodo Payments الرابط غير المدفوع، ويستبدل تغيير الخطة الجديد التغيير المعلّق. ولن يقبل الرابط الملغى أي دفعة بعد ذلك. يُتحقق من صحة الطلب قبل إلغاء الرابط، لذلك يحافظ الطلب غير الصالح على رابط العميل. ولا يُلغى الرابط إلا إذا لم يبدأ العميل الدفع: يُصدر كل طلب change-plan فاتورته الخاصة. ويُلغى تغيير الخطة المستبدَل وفاتورته.
راجع دليل ترقية الاشتراك وخفضه للاطلاع على التدفق الكامل، بما في ذلك الدفعات المرفوضة، واستبدال رابط معلّق، وما يحدث عند انتهاء صلاحية الرابط.

رموز الخصم

يمكنك تطبيق رموز خصم مكدّسة واحدة أو أكثر عند تغيير الخطط، وذلك بتمرير مصفوفة discount_codes (بحد أقصى 20 إدخالًا، وتُطبّق حسب ترتيب المصفوفة). أما الحقل المفرد discount_code فهو deprecated لكنه لا يزال يعمل مع عمليات التكامل الحالية؛ ولا يمكن دمجه مع discount_codes في الطلب نفسه.
استخدم رموز الخصم أثناء تغييرات الخطة لتقديم أسعار ترويجية عند الترقية، أو مرّر الرموز عند نقل العملاء إلى مستوى خطة جديد.
استخدم 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

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.

آخر تعديل في ٨ أكتوبر ٢٠٢٦