Method: billingProfiles.list

    • The billingProfiles.list method retrieves a paginated list of billing profiles, which can be filtered by various parameters such as currency, subaccount, status, and name.

    • The HTTP request uses a GET method and includes a path parameter for the user profile ID.

    • The response body contains a list of billing profile objects along with a nextPageToken for pagination.

    • This method requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope for authorization.

    Retrieves a list of billing profiles, possibly filtered. This method supports paging .

    HTTP request

    GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/billingProfiles

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    profileId

    string ( int64 format)

    User profile ID associated with this request.

    Query parameters

    Parameters
    maxResults

    integer

    Maximum number of results to return.
    currency_code

    string

    Select only billing profile with currency.
    subaccountIds[]

    string ( int64 format)

    Select only billing profile with the specified subaccount.When onlySuggestion is true, only a single subaccountId is supported.
    status[]

    enum ( BillingStatus )

    Select only billing profile with the specified status.
    onlySuggestion

    boolean

    Select only billing profile which is suggested for the currencyCode & subaccountId using the Billing Suggestion API.
    ids[]

    string ( int64 format)

    Select only billing profile with these IDs.
    name

    string

    Allows searching for billing profiles by name. Wildcards (

    *

    ) are allowed. For example,

    "profile*2020"

    will return objects with names like

    "profile June 2020"

    ,

    "profile April 2020"

    , or simply

    "profile 2020"

    . Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of

    "profile"

    will match objects with name

    "my profile"

    ,

    "profile 2021"

    , or simply

    "profile"

    .
    pageToken

    string

    Value of the

    nextPageToken

    from the previous result page.
    sortField

    enum ( SortField )

    Field by which to sort the list.
    sortOrder

    enum ( SortOrder )

    Order of sorted results.

    Request body

    The request body must be empty.

    Response body

    Billing profile billingProfiles.list Response

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

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "billingProfiles" 
 : 
 [ 
 { 
 object (  BillingProfile 
 
) 
 } 
 ] 
 }
    Fields
    kind

    string

    Identifies what kind of resource this is. Value: the fixed string

    "dfareporting#billingProfilesListResponse"

    .
    nextPageToken

    string

    Pagination token to be used for the next list operation.
    billingProfiles[]

    object ( BillingProfile )

    Billing profiles collection.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/dfatrafficking
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: