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.billingSetups.mutate

Creates a billing setup, or cancels an existing billing setup.

List of thrown errors: AuthenticationError AuthorizationError BillingSetupError DateError FieldError HeaderError InternalError MutateError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v8/customers/{customerId}/billingSetups:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. Id of the customer to apply the billing setup mutate operation to.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operation": {
    object (BillingSetupOperation)
  }
}
Fields
operation

object (BillingSetupOperation)

Required. The operation to perform.

Response body

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

Response message for a billing setup operation.

JSON representation
{
  "result": {
    object (MutateBillingSetupResult)
  }
}
Fields
result

object (MutateBillingSetupResult)

A result that identifies the resource affected by the mutate request.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

BillingSetupOperation

A single operation on a billing setup, which describes the cancellation of an existing billing setup.

JSON representation
{

  // Union field operation can be only one of the following:
  "create": {
    object (BillingSetup)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
Fields
Union field operation. Only one of these operations can be set. "Update" operations are not supported. operation can be only one of the following:
create

object (BillingSetup)

Creates a billing setup. No resource name is expected for the new billing setup.

remove

string

Resource name of the billing setup to remove. A setup cannot be removed unless it is in a pending state or its scheduled start time is in the future. The resource name looks like customers/{customerId}/billingSetups/{billing_id}.

MutateBillingSetupResult

Result for a single billing setup mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.