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)

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

string (int64 format)

פלט בלבד. המזהה של הגדרת החיוב.
paymentsAccount

string

לא משתנה. שם המשאב של חשבון התשלומים המשויך להגדרת החיוב הזו. השמות של משאבי התשלומים הם:

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

הסטטוסים האפשריים של הגדרת חיוב.

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

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