الانتقال إلى المحتوى الرئيسي
POST
/
subscriptions
/
{subscription_id}
/
update-payment-method
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const response = await client.subscriptions.updatePaymentMethod('subscription_id', { type: 'new' });

console.log(response.payment_id);
{
  "client_secret": "<string>",
  "expires_on": "2023-11-07T05:31:56Z",
  "payment_id": "<string>",
  "payment_link": "<string>"
}
قم بتحديث طريقة الدفع لاشتراك. يدعم هذا الطرف النشط الاشتراكات النشطة والاشتراكات في حالة on_hold.
بالنسبة للاشتراكات في حالة on_hold، يؤدي تحديث طريقة الدفع تلقائيًا إلى إنشاء رسوم للمستحقات المتبقية، وإنشاء فاتورة، وإعادة تنشيط الاشتراك إلى حالة active عند نجاح الدفع.

​
حالات الاستخدام

  • الاشتراكات النشطة: تحديث طريقة الدفع عندما تنتهي صلاحية بطاقة أو يرغب العميل في استخدام طريقة دفع مختلفة
  • الاشتراكات المعلقة: إعادة تنشيط الاشتراكات التي تم تعليقها بسبب فشل المدفوعات عن طريق تحديث طريقة الدفع
  • إدارة طرق الدفع: التبديل بين طرق الدفع المحفوظة أو إضافة طرق جديدة
لقائمة طرق الدفع الموجودة لعميل، استخدم واجهة برمجة تطبيقات قائمة طرق الدفع. يساعدك ذلك في استرداد معرفات طرق الدفع المتاحة عند استخدام type: "existing" لتحديث طريقة الدفع في اشتراك.

​
السلوك للاشتراكات النشطة

عند تحديث طريقة الدفع لاشتراك نشط:
  • يتم تحديث طريقة الدفع على الفور
  • لا يتم إنشاء رسوم
  • يبقى الاشتراك نشطًا
  • ستستخدم التجديدات المستقبلية طريقة الدفع الجديدة

​
السلوك للاشتراكات المعلقة

عند تحديث طريقة الدفع لاشتراك في حالة on_hold:
  1. يتم إنشاء رسوم تلقائيًا للمستحقات المتبقية
  2. يتم إنشاء فاتورة للرسوم
  3. تتم معالجة الدفع باستخدام طريقة الدفع الجديدة
  4. عند نجاح الدفع، يتم إعادة تنشيط الاشتراك إلى حالة active
  5. ستتلقى أحداث ويب هوك: payment.succeeded متبوعًا بـsubscription.active
إذا فشل الدفع بعد تحديث طريقة الدفع لاشتراك في حالة on_hold، سيبقى الاشتراك في حالة on_hold. راقب أحداث الويب هوك لتتبع حالة الدفع.

​
أحداث ويب هوك

عند تحديث طريقة الدفع لاشتراك في حالة on_hold، ستتلقى أحداث ويب هوك التالية:
  1. payment.succeeded - تم نجاح الرسوم للمستحقات المتبقية
  2. subscription.active - تم إعادة تنشيط الاشتراك

التفويضات

​
Authorization
string
header
مطلوب

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

معلمات المسار

​
subscription_id
string
مطلوب

Subscription Id

الجسم

application/json
​
type
enum<string>
مطلوب
الخيارات المتاحة:
new
​
return_url
string | null

الاستجابة

Payment method updated

​
client_secret
string | null
​
expires_on
string<date-time> | null
​
payment_id
string | null
​
payment_link
string | null