الانتقال إلى المحتوى الرئيسي
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 - تم إعادة تنشيط الاشتراك

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
subscription_id
string
required

Subscription Id

Body

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

Response

Payment method updated

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