BillingSetup

إعداد الفوترة الذي يربط حساب دفعات بمعلِن يكون إعداد الفوترة خاصًا بمعلِن واحد.

تمثيل JSON 
{
  "resourceName": string,
  "status": enum (BillingSetupStatus),
  "paymentsAccountInfo": {
    object (PaymentsAccountInfo)
  },
  "id": string,
  "paymentsAccount": string,

  // Union field start_time can be only one of the following:
  "startDateTime": string,
  "startTimeType": enum (TimeType)
  // End of list of possible types for union field start_time.

  // Union field end_time can be only one of the following:
  "endDateTime": string,
  "endTimeType": enum (TimeType)
  // End of list of possible types for union field end_time.
}
الحقول
resourceName

string

غير قابل للتغيير اسم المورد لإعدادات الفوترة تكون أسماء موارد BillingSetup على النحو التالي:

customers/{customerId}/billingSetups/{billing_setup_id}
status

enum (BillingSetupStatus)

النتائج فقط. حالة إعداد الفوترة
paymentsAccountInfo

object (PaymentsAccountInfo)

غير قابل للتغيير معلومات حساب الدفعات المرتبطة بإعداد الفوترة هذا. عند إعداد الفوترة، يتم استخدام هذا الإجراء للاشتراك باستخدام حساب دفعات جديد (وبعد ذلك يجب عدم ضبط paymentsAccount). عند الحصول على إعداد الفوترة، سيتمّ تعبئة هذا الحقل وpaymentsAccount.
id

string (int64 format)

النتائج فقط. رقم تعريف إعداد الفوترة
paymentsAccount

string

غير قابل للتغيير. اسم مورد حساب الدفعات المرتبط بإعداد الفوترة هذا. وتكون أسماء مصادر الدفعات على النحو التالي:

customers/{customerId}/paymentsAccounts/{paymentsAccountId} عند إعداد الفوترة، يتم استخدام هذا العنصر للاشتراك باستخدام حساب دفعات حالي (وبعد ذلك يجب عدم ضبط paymentsAccountInfo). عند الحصول على إعداد الفوترة، سيتمّ ملء هذا الحقل وpaymentsAccountInfo.

حقل الربط start_time عند إنشاء إعداد فوترة جديد، من المفترض أن يسري هذا الإعداد في هذا التاريخ. "الآن" هو وقت البدء الوحيد المقبول إذا لم يكن لدى العميل أي عمليات إعداد تمت الموافقة عليها.

عند جلب إعداد فوترة حالي، يكون هذا هو وقت البدء المطلوب. ومع ذلك، إذا تمت الموافقة على عملية الإعداد (راجِع الحالة) بعد وقت البدء المطلوب، سيكون هذا هو وقت الموافقة. يمكن أن يكون start_time واحدًا فقط مما يلي:
startDateTime

string

غير قابل للتغيير وقت تاريخ البدء بالتنسيق yyyy-MM-dd أو yyyy-MM-dd HH:mm:ss. يُسمح بتحديد وقت لاحق فقط.
startTimeType

enum (TimeType)

غير قابل للتغيير وقت البدء كنوع يُسمح باستخدام NOW فقط.
حقل الربط end_time وقت انتهاء إعداد الفوترة يمكن أن يكون هذا الإعداد إما إلى الأبد أو وقت بدء عملية إعداد الفوترة التالية المُجدوَلة. يمكن أن يكون end_time واحدًا فقط مما يلي:
endDateTime

string

النتائج فقط. وقت تاريخ الانتهاء بالتنسيق yyyy-MM-dd أو yyyy-MM-dd HH:mm:ss
endTimeType

enum (TimeType)

النتائج فقط. وقت الانتهاء كنوع. القيمة الوحيدة الممكنة هي FOREVER.

BillingSetupStatus

الحالات المحتمَلة لإعداد الفوترة

عمليات التعداد
UNSPECIFIED غير محدّد
UNKNOWN تُستخدَم لقيمة الإرجاع فقط. يمثل هذا الحقل قيمة غير معروفة في هذا الإصدار.
PENDING إعداد الفوترة في انتظار الموافقة.
APPROVED_HELD تمّت الموافقة على إعدادات الفوترة ولكنّه لم يتمّ ذلك بالنسبة إلى الميزانية الأولى المقابلة. ولا يمكن أن يحدث ذلك إلا لإعدادات الفوترة التي تم ضبطها لنظام الفواتير الشهرية.
APPROVED تمت الموافقة على عملية ضبط إعدادات الفوترة.
CANCELLED ألغى المستخدم إعداد الفوترة قبل الموافقة.

PaymentsAccountInfo

حاوية لمعلومات حساب الدفعات لهذه الفوترة

تمثيل JSON 
{
  "paymentsAccountId": string,
  "paymentsAccountName": string,
  "paymentsProfileId": string,
  "paymentsProfileName": string,
  "secondaryPaymentsProfileId": string
}
الحقول
paymentsAccountId

string

النتائج فقط. معرّف مكوّن من 16 رقمًا يُستخدَم لتحديد حساب الدفعات المرتبط بإعدادات الفوترة.

يجب تمرير هذا الرمز كسلسلة مع شرطات، على سبيل المثال، "1234-5678-9012-3456".
paymentsAccountName

string

غير قابل للتغيير اسم حساب الدفعات المرتبط بإعداد الفوترة

يتيح ذلك للمستخدم تحديد اسم ذي معنى لحساب الدفعات للمساعدة في تسوية الفواتير الشهرية.

سيتم طباعة هذا الاسم في الفواتير الشهرية.
paymentsProfileId

string

غير قابل للتغيير. معرّف مكوّن من 12 رقمًا يُستخدَم لتحديد ملف الدفع المرتبط بإعداد الفوترة.

ويجب تمريره كسلسلة مع شرطات، على سبيل المثال، "1234-5678-9012".
paymentsProfileName

string

النتائج فقط. اسم ملف الدفع المرتبط بإعدادات الفوترة
secondaryPaymentsProfileId

string

النتائج فقط. يظهر معرّف ثانوي لملف الدفع في حالات غير شائعة، مثل ترتيب اتفاقية مسؤولية تسلسلية.