Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.paymentsAccounts.list

Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError PaymentsAccountError QuotaError RequestError

HTTP request

GET https://googleads.googleapis.com/v7/customers/{customerId}/paymentsAccounts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer to apply the PaymentsAccount list operation to.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for PaymentsAccountService.ListPaymentsAccounts.

JSON representation
{
  "paymentsAccounts": [
    {
      object (PaymentsAccount)
    }
  ]
}
Fields
paymentsAccounts[]

object (PaymentsAccount)

The list of accessible payments accounts.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PaymentsAccount

A payments account, which can be used to set up billing for an Ads customer.

JSON representation
{
  "resourceName": string,
  "paymentsAccountId": string,
  "name": string,
  "currencyCode": string,
  "paymentsProfileId": string,
  "secondaryPaymentsProfileId": string,
  "payingManagerCustomer": string
}
Fields
resourceName

string

Output only. The resource name of the payments account. PaymentsAccount resource names have the form:

customers/{customerId}/paymentsAccounts/{paymentsAccountId}

paymentsAccountId

string

Output only. A 16 digit ID used to identify a payments account.

name

string

Output only. The name of the payments account.

currencyCode

string

Output only. The currency code of the payments account. A subset of the currency codes derived from the ISO 4217 standard is supported.

paymentsProfileId

string

Output only. A 12 digit ID used to identify the payments profile associated with the payments account.

secondaryPaymentsProfileId

string

Output only. A secondary payments profile ID present in uncommon situations, e.g. when a sequential liability agreement has been arranged.

payingManagerCustomer

string

Output only. Paying manager of this payment account.