REST Resource: billingProfiles

  • The Billing Profile resource outlines the billing setup for Campaign Manager, including information like currency, invoice level, and payment details.

  • Billing Profiles can be retrieved, updated, and listed using the provided methods.

  • Important Billing Profile properties include ID, name, status, country and currency codes, purchase order, invoice level, and payment identifiers.

  • Billing Profiles have three statuses: UNDER_REVIEW, ACTIVE, and ARCHIVED, and can be invoiced at the ACCOUNT, ADVERTISER, or CAMPAIGN level.

Resource: BillingProfile

Contains properties of a Campaign Manager Billing Profile.

JSON representation 
{
  "id": string,
  "name": string,
  "status": enum (BillingStatus),
  "countryCode": string,
  "currencyCode": string,
  "purchaseOrder": string,
  "invoiceLevel": enum (InvoiceLevel),
  "consolidatedInvoice": boolean,
  "paymentsAccountId": string,
  "paymentsCustomerId": string,
  "secondaryPaymentsCustomerId": string,
  "isDefault": boolean,
  "kind": string
}
Fields
id

string (int64 format)

ID of this billing profile. This is a read-only, auto-generated field.
name

string

Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account.
status

enum (BillingStatus)

Status of this billing profile.This is a read-only field.
countryCode

string

Country code of this billing profile.This is a read-only field.
currencyCode

string

Billing currency code in ISO 4217 format.This is a read-only field.
purchaseOrder

string

Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile.
invoiceLevel

enum (InvoiceLevel)

Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign.
consolidatedInvoice

boolean

Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level.
paymentsAccountId

string

The ID of the payment account the billing profile belongs to. This is a read-only field.
paymentsCustomerId

string

The ID of the payment customer the billing profile belongs to. This is a read-only field.
secondaryPaymentsCustomerId

string

The ID of the secondary payment customer the billing profile belongs to. This is a read-only field.
isDefault

boolean

True if the billing profile is the account default profile. This is a read-only field.
kind

string

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

"dfareporting#billingProfile"

.

InvoiceLevel

Enums
ACCOUNT_LEVEL
ADVERTISER_LEVEL
CAMPAIGN_LEVEL

Methods

get

 Gets one billing profile by ID.

list

 Retrieves a list of billing profiles, possibly filtered.

update

 Updates an existing billing profile.