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)

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

string (int64 format)

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

string

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

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

שדה איחוד 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

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