GoogleAdsGoogleadsV25Services__MutateBillingSetupRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-mutate-billing-setup-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateBillingSetupRequest",
  "description": "Request message for billing setup mutate operations.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-billingsetups-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateBillingSetupRequest",
  "type": "object",
  "properties": {
    "operation": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__BillingSetupOperation",
      "description": "Required. The operation to perform."
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources_BillingSetup_PaymentsAccountInfo": {
      "description": "Container of payments account information for this billing.",
      "type": "object",
      "properties": {
        "paymentsAccountName": {
          "description": "Immutable. The name of the payments account associated with the billing setup. This enables the user to specify a meaningful name for a payments account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices.",
          "type": "string"
        },
        "paymentsProfileId": {
          "type": "string",
          "description": "Immutable. A 12 digit id used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, for example, \"1234-5678-9012\"."
        },
        "secondaryPaymentsProfileId": {
          "type": "string",
          "description": "Output only. A secondary payments profile id present in uncommon situations, for example, when a sequential liability agreement has been arranged."
        },
        "paymentsAccountId": {
          "description": "Output only. A 16 digit id used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, \"1234-5678-9012-3456\".",
          "type": "string"
        },
        "paymentsProfileName": {
          "description": "Output only. The name of the payments profile associated with the billing setup.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Resources__BillingSetup": {
      "description": "A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.",
      "type": "object",
      "properties": {
        "paymentsAccountInfo": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources_BillingSetup_PaymentsAccountInfo",
          "description": "Immutable. The payments account information associated with this billing setup. When setting up billing, this is used to signup with a new payments account (and then payments_account should not be set). When getting a billing setup, this and payments_account will be populated."
        },
        "id": {
          "format": "int64",
          "type": "string",
          "description": "Output only. The ID of the billing setup."
        },
        "status": {
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "PENDING",
            "APPROVED_HELD",
            "APPROVED",
            "CANCELLED"
          ],
          "type": "string",
          "description": "Output only. The status of the billing setup.",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "The billing setup is pending approval.",
            "The billing setup has been approved but the corresponding first budget has not. This can only occur for billing setups configured for monthly invoicing.",
            "The billing setup has been approved.",
            "The billing setup was cancelled by the user prior to approval."
          ]
        },
        "paymentsAccount": {
          "description": "Immutable. The resource name of the payments account associated with this billing setup. Payments resource names have the form: `customers/{customer_id}/paymentsAccounts/{payments_account_id}` When setting up billing, this is used to signup with an existing payments account (and then payments_account_info should not be set). When getting a billing setup, this and payments_account_info will be populated.",
          "type": "string"
        },
        "resourceName": {
          "description": "Immutable. The resource name of the billing setup. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`",
          "type": "string"
        },
        "startDateTime": {
          "description": "Immutable. The start date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format. Only a future time is allowed.",
          "type": "string"
        },
        "endTimeType": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "As soon as possible.",
            "An infinite point in the future."
          ],
          "type": "string",
          "description": "Output only. The end time as a type. The only possible value is FOREVER.",
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "NOW",
            "FOREVER"
          ]
        },
        "startTimeType": {
          "description": "Immutable. The start time as a type. Only NOW is allowed.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "As soon as possible.",
            "An infinite point in the future."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "NOW",
            "FOREVER"
          ]
        },
        "endDateTime": {
          "description": "Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__BillingSetupOperation": {
      "type": "object",
      "properties": {
        "create": {
          "description": "Creates a billing setup. No resource name is expected for the new billing setup.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__BillingSetup"
        },
        "remove": {
          "description": "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/{customer_id}/billingSetups/{billing_id}`.",
          "type": "string"
        }
      },
      "description": "A single operation on a billing setup, which describes the cancellation of an existing billing setup."
    }
  }
}