Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateBillingGroup

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

Request Syntax


PATCH /billing-groups/billingGroupName HTTP/1.1
Content-type: application/json

{
   "billingGroupProperties": { 
      "billingGroupDescription": "string"
   },
   "expectedVersion": number
}

URI Request Parameters

The request uses the following URI parameters.

billingGroupName

The name of the billing group.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

billingGroupProperties

The properties of the billing group.

Type: BillingGroupProperties object

Required: Yes

expectedVersion

The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.

Type: Long

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "version": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

version

The latest version of the billing group.

Type: Long

Errors

InternalFailureException

An unexpected error has occurred.

message: The message for the exception.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

message: The message for the exception.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

message: The message for the exception.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

message: The message for the exception.

HTTP Status Code: 400

VersionConflictException

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

message: The message for the exception.

HTTP Status Code: 409