The Payment Details API retrieves the current and upcoming billing details for a site's Google Ads account, including ad spend for the active billing period and any scheduled future payments. The data is calculated from subscription information rather than queried live from Google Ads.
- Retrieve the current and upcoming billing periods for the site's Google Ads account, including ad spend for each.
- Retrieve the account's remaining credit balance and scheduled upcoming payment amounts.
It's important to note the following points before starting to code:
- A Google Ads account must exist for the site before calling this service. Use the Account API to create one.
- The response contains the current and, where available, the next upcoming billing period. It is not a historical ledger of past months.
- The data is calculated from subscription information, not queried live from Google Ads.
creditBalance is a single account-level value, not scoped to a billing period. It can be negative, indicating outstanding debt before the charge has been applied. It's only populated for accounts on a weekly billing cycle.- Use
upcomingPayments to retrieve future billing amounts. The monthlyPayments field is deprecated and currently returns the same data as upcomingPayments.
- Amounts are expressed as decimal strings in the account's billing currency (for example,
"123.45").
- If the site's billing setup for the Google Ads account isn't complete, this call may fail.
- Payment Record: An entry showing the total ad spend and billing details for the current or an upcoming billing period of a site's Google Ads account.
- creditBalance: The remaining promotional or prepaid credit on the account. A negative value indicates outstanding debt before the charge is applied.
- upcomingPayments: The list of future scheduled billing amounts, replacing the deprecated
monthlyPayments field.