REST Resource: billingProfiles
Stay organized with collections
Save and categorize content based on your preferences.
Resource: BillingProfile
| 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"
.
|
BillingStatus
| Enums |
UNDER_REVIEW |
|
ACTIVE |
|
ARCHIVED |
|
InvoiceLevel
| Enums |
ACCOUNT_LEVEL |
|
ADVERTISER_LEVEL |
|
CAMPAIGN_LEVEL |
|
Methods |
|
|
Gets one billing profile by ID. |
|
|
Retrieves a list of billing profiles, possibly filtered. |
|
|
Updates an existing billing profile. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe Billing Profile resource outlines the billing setup for Campaign Manager, including information like currency, invoice level, and payment details.\u003c/p\u003e\n"],["\u003cp\u003eBilling Profiles can be retrieved, updated, and listed using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eImportant Billing Profile properties include ID, name, status, country and currency codes, purchase order, invoice level, and payment identifiers.\u003c/p\u003e\n"],["\u003cp\u003eBilling Profiles have three statuses: UNDER_REVIEW, ACTIVE, and ARCHIVED, and can be invoiced at the ACCOUNT, ADVERTISER, or CAMPAIGN level.\u003c/p\u003e\n"]]],[],null,["# REST Resource: billingProfiles\n\n- [Resource: BillingProfile](#BillingProfile)\n - [JSON representation](#BillingProfile.SCHEMA_REPRESENTATION)\n- [BillingStatus](#BillingStatus)\n- [InvoiceLevel](#InvoiceLevel)\n- [Methods](#METHODS_SUMMARY)\n\nResource: BillingProfile\n------------------------\n\nContains properties of a Campaign Manager [Billing Profile](https://support.google.com/campaignmanager/answer/10613970).\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": string, \"status\": enum (/doubleclick-advertisers/rest/v4/billingProfiles#BillingStatus), \"countryCode\": string, \"currencyCode\": string, \"purchaseOrder\": string, \"invoiceLevel\": enum (/doubleclick-advertisers/rest/v4/billingProfiles#InvoiceLevel), \"consolidatedInvoice\": boolean, \"paymentsAccountId\": string, \"paymentsCustomerId\": string, \"secondaryPaymentsCustomerId\": string, \"isDefault\": boolean, \"kind\": string } ``` |\n\n| Fields ||\n|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of this billing profile. This is a read-only, auto-generated field. |\n| `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. |\n| `status` | `enum (`[BillingStatus](/doubleclick-advertisers/rest/v4/billingProfiles#BillingStatus)`)` Status of this billing profile.This is a read-only field. |\n| `country``Code` | `string` Country code of this billing profile.This is a read-only field. |\n| `currency``Code` | `string` Billing currency code in ISO 4217 format.This is a read-only field. |\n| `purchase``Order` | `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. |\n| `invoice``Level` | `enum (`[InvoiceLevel](/doubleclick-advertisers/rest/v4/billingProfiles#InvoiceLevel)`)` Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign. |\n| `consolidated``Invoice` | `boolean` Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level. |\n| `payments``Account``Id` | `string` The ID of the payment account the billing profile belongs to. This is a read-only field. |\n| `payments``Customer``Id` | `string` The ID of the payment customer the billing profile belongs to. This is a read-only field. |\n| `secondary``Payments``Customer``Id` | `string` The ID of the secondary payment customer the billing profile belongs to. This is a read-only field. |\n| `is``Default` | `boolean` True if the billing profile is the account default profile. This is a read-only field. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#billingProfile\"` . |\n\nBillingStatus\n-------------\n\n| Enums ||\n|----------------|---|\n| `UNDER_REVIEW` | |\n| `ACTIVE` | |\n| `ARCHIVED` | |\n\nInvoiceLevel\n------------\n\n| Enums ||\n|--------------------|---|\n| `ACCOUNT_LEVEL` | |\n| `ADVERTISER_LEVEL` | |\n| `CAMPAIGN_LEVEL` | |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------|----------------------------------------------------------|\n| ### [get](/doubleclick-advertisers/rest/v4/billingProfiles/get) | Gets one billing profile by ID. |\n| ### [list](/doubleclick-advertisers/rest/v4/billingProfiles/list) | Retrieves a list of billing profiles, possibly filtered. |\n| ### [update](/doubleclick-advertisers/rest/v4/billingProfiles/update) | Updates an existing billing profile. |"]]
