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.

REST Resource: customers.accountBudgetProposals

Resource: AccountBudgetProposal

An account-level budget proposal.

All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, e.g. spending limits.

Please note that the proposal type (proposalType) changes which fields are required and which must remain empty.

JSON representation
{
  "resourceName": string,
  "proposalType": enum (AccountBudgetProposalType),
  "status": enum (AccountBudgetProposalStatus),
  "id": string,
  "billingSetup": string,
  "accountBudget": string,
  "proposedName": string,
  "approvedStartDateTime": string,
  "proposedPurchaseOrderNumber": string,
  "proposedNotes": string,
  "creationDateTime": string,
  "approvalDateTime": string,

  // Union field proposed_start_time can be only one of the following:
  "proposedStartDateTime": string,
  "proposedStartTimeType": enum (TimeType)
  // End of list of possible types for union field proposed_start_time.

  // Union field proposed_end_time can be only one of the following:
  "proposedEndDateTime": string,
  "proposedEndTimeType": enum (TimeType)
  // End of list of possible types for union field proposed_end_time.

  // Union field approved_end_time can be only one of the following:
  "approvedEndDateTime": string,
  "approvedEndTimeType": enum (TimeType)
  // End of list of possible types for union field approved_end_time.

  // Union field proposed_spending_limit can be only one of the following:
  "proposedSpendingLimitMicros": string,
  "proposedSpendingLimitType": enum (SpendingLimitType)
  // End of list of possible types for union field proposed_spending_limit.

  // Union field approved_spending_limit can be only one of the following:
  "approvedSpendingLimitMicros": string,
  "approvedSpendingLimitType": enum (SpendingLimitType)
  // End of list of possible types for union field approved_spending_limit.
}
Fields
resourceName

string

Immutable. The resource name of the proposal. AccountBudgetProposal resource names have the form:

customers/{customerId}/accountBudgetProposals/{account_budget_proposal_id}

proposalType

enum (AccountBudgetProposalType)

Immutable. The type of this proposal, e.g. END to end the budget associated with this proposal.

status

enum (AccountBudgetProposalStatus)

Output only. The status of this proposal. When a new proposal is created, the status defaults to PENDING.

id

string (int64 format)

Output only. The ID of the proposal.

billingSetup

string

Immutable. The resource name of the billing setup associated with this proposal.

accountBudget

string

Immutable. The resource name of the account-level budget associated with this proposal.

proposedName

string

Immutable. The name to assign to the account-level budget.

approvedStartDateTime

string

Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format.

proposedPurchaseOrderNumber

string

Immutable. A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices.

proposedNotes

string

Immutable. Notes associated with this budget.

creationDateTime

string

Output only. The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable.

approvalDateTime

string

Output only. The date time when this account-level budget was approved, if applicable.

Union field proposed_start_time. The proposed start date time of the account-level budget, which cannot be in the past. proposed_start_time can be only one of the following:
proposedStartDateTime

string

Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format.

proposedStartTimeType

enum (TimeType)

Immutable. The proposed start date time as a well-defined type, e.g. NOW.

Union field proposed_end_time. The proposed end date time of the account-level budget, which cannot be in the past. proposed_end_time can be only one of the following:
proposedEndDateTime

string

Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format.

proposedEndTimeType

enum (TimeType)

Immutable. The proposed end date time as a well-defined type, e.g. FOREVER.

Union field approved_end_time. The approved end date time of the account-level budget. approved_end_time can be only one of the following:
approvedEndDateTime

string

Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format.

approvedEndTimeType

enum (TimeType)

Output only. The approved end date time as a well-defined type, e.g. FOREVER.

Union field proposed_spending_limit. The proposed spending limit. proposed_spending_limit can be only one of the following:
proposedSpendingLimitMicros

string (int64 format)

Immutable. The proposed spending limit in micros. One million is equivalent to one unit.

proposedSpendingLimitType

enum (SpendingLimitType)

Immutable. The proposed spending limit as a well-defined type, e.g. INFINITE.

Union field approved_spending_limit. The approved spending limit. approved_spending_limit can be only one of the following:
approvedSpendingLimitMicros

string (int64 format)

Output only. The approved spending limit in micros. One million is equivalent to one unit.

approvedSpendingLimitType

enum (SpendingLimitType)

Output only. The approved spending limit as a well-defined type, e.g. INFINITE.

AccountBudgetProposalStatus

The possible statuses of an AccountBudgetProposal.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The proposal is pending approval.
APPROVED_HELD The proposal has been approved but the corresponding billing setup has not. This can occur for proposals that set up the first budget when signing up for billing or when performing a change of bill-to operation.
APPROVED The proposal has been approved.
CANCELLED The proposal has been cancelled by the user.
REJECTED The proposal has been rejected by the user, e.g. by rejecting an acceptance email.

Methods

get

Returns an account-level budget proposal in full detail.

mutate

Creates, updates, or removes account budget proposals.