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

קבוע. שם המשאב בחשבון התשלומים שמשויך להגדרת החיוב הזו. שמות המשאבים של Payments מופיעים בפורמט:

customers/{customerId}/paymentsAccounts/{paymentsAccountId} כשמגדירים את החיוב, השדה הזה משמש להרשמה באמצעות חשבון תשלומים קיים (ואז לא צריך להגדיר את paymentsAccountInfo). כשמקבלים הגדרת חיוב, השדות הזה ו-paymentsAccountInfo מאוכלסים.

שדה האיחוד start_time. כשאתם יוצרים הגדרת חיוב חדשה, זה התאריך שבו ההגדרה אמורה להיכנס לתוקף. שעת ההתחלה היחידה שנתמכת היא NOW אם אין ללקוח הגדרות שאושרו.

כשמאחזרים הגדרת חיוב קיימת, זו שעת ההתחלה המבוקשת. עם זאת, אם ההגדרה אושרה (לפי הסטטוס) אחרי שעת ההתחלה המבוקשת, זהו מועד האישור. הערך של 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

אלו הם הסטטוסים האפשריים של BillingSetup.

טיפוסים בני מנייה (enum)
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

פלט בלבד. מספר פרופיל תשלומים משני שמופיע במצבים לא נפוצים, לדוגמה, לאחר הסדרת הסכם זכות עיכבון.