Contact UsGet started

Billing API, REST: BillingAccount.BindBillableObject

Written by
Updated at November 26, 2024

Binds billable object to the specified billing account.

HTTP request

POST https://billing.api.cloud.yandex.net/billing/v1/billingAccounts/{billingAccountId}/billableObjectBindings

Path parameters

Field

Description

billingAccountId

string

Required field. ID of the billing account to bind billable object.
To get the billing account ID, use BillingAccountService.List request.

Body parameters

{
  "billableObject": {
    "id": "string",
    "type": "string"
  }
}

Field

Description

billableObject

BillableObject

yandex.cloud.billing.v1.BillableObject to bind with billing account.

BillableObject

Represents a link to an object in other service.
This object is being billed in the scope of a billing account.

Field

Description

id

string

ID of the object in other service.

type

string

Billable object type. Can be one of the following:

  • cloud

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "billableObjectId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "effectiveTime": "string",
    "billableObject": {
      "id": "string",
      "type": "string"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

BindBillableObjectMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

BillableObjectBinding

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

BindBillableObjectMetadata

Field

Description

billableObjectId

string

ID of the yandex.cloud.billing.v1.BillableObject that was bound to billing account.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

BillableObjectBinding

Represents a binding of the BillableObject to a BillingAccount.

Field

Description

effectiveTime

string (date-time)

Timestamp when binding was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

billableObject

BillableObject

Object that is bound to billing account.

BillableObject

Represents a link to an object in other service.
This object is being billed in the scope of a billing account.

Field

Description

id

string

ID of the object in other service.

type

string

Billable object type. Can be one of the following:

  • cloud
Previous
ListBillableObjectBindings
Next
ListAccessBindings