Skip to main content

types

BalanceBudgetSpec​

Balance budget specification describes budget that can be used to control yandex.cloud.billing.v1.BillingAccount.balance.

amount : string​

Max balance threshold of the budget. Amount currency is the same as corresponding yandex.cloud.billing.v1.BillingAccount.currency.

notificationUserAccountIds : string​

IDs of the yandex.cloud.iam.v1.UserAccount. Specified users will be be notified if the budget exceeds.

thresholdRules : ThresholdRule​

List of the ThresholdRule. Rules define intermediate balance thresholds of the budget.

startDate : string​

Start_date of the budget. Must be the first day of a month and must be formatted like YYYY-MM-DD.

endDate : string​

End date of the budget. Must be the last day of a month and must be formatted like YYYY-MM-DD.

BillableObject​

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

id : string​

ID of the object in other service.

type : string​

Billable object type. Can be one of the following:

  • cloud

BillableObjectBinding​

Represents a binding of the BillableObject to a BillingAccount.

effectiveTime : google.protobuf.Timestamp​

Timestamp when binding was created.

billableObject : BillableObject​

Object that is bound to billing account.

BillingAccount​

A BillingAccount resource. For more information, see BillingAccount.

id : string​

ID of the billing account.

name : string​

Name of the billing account.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

countryCode : string​

ISO 3166-1 alpha-2 country code of the billing account.

currency : string​

Currency of the billing account. Can be one of the following:

  • RUB
  • USD
  • KZT
active : bool​

Represents whether corresponding billable objects can be used or not.

balance : string​

Current balance of the billing account.

Budget​

A Budget resource. For more information, see /docs/billing/concepts/budget.

id : string​

ID of the budget.

name : string​

Name of the budget.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

billingAccountId : string​

ID of the billing account that the budget belongs to.

status : BudgetStatus​

Status of the budget.

One of budgetSpec​

Specification of the budget.

  • costBudget : CostBudgetSpec​

    Cost budget specification.

  • expenseBudget : ExpenseBudgetSpec​

    Expense budget specification.

  • balanceBudget : BalanceBudgetSpec​

    Balance budget specification.

CloudFoldersConsumptionFilter​

Filter that can be used for specific cloud and its folders selection.

cloudId : string​

ID of the yandex.cloud.resourcemanager.v1.Cloud. Only consumption within specified cloud is used for the budget calculation.

folderIds : string​

IDs of the yandex.cloud.resourcemanager.v1.Folder. Only consumption within specified folders of the given cloud is used for the budget calculation. Empty sequence means no folders filters and the whole cloud consumption will be used.

ConsumptionFilter​

Filter that can be used for specific resources selection.

serviceIds : string​

IDs of the yandex.cloud.billing.v1.Service. Only consumption of resources corresponding to the given services is used for the budget calculation. Empty sequence means no services filters.

cloudFoldersFilters : CloudFoldersConsumptionFilter​

Cloud and folders consumption filter. Only consumption within specified clouds and folders is used for the budget calculation. Empty sequence means no cloud and folders filters.

CostBudgetSpec​

Cost budget specification describes budget that can be used to control cost of cloud resources usage.

amount : string​

Max cost threshold of the budget. Amount currency is the same as corresponding yandex.cloud.billing.v1.BillingAccount.currency.

notificationUserAccountIds : string​

IDs of the yandex.cloud.iam.v1.UserAccount. Specified users will be be notified if the budget exceeds.

thresholdRules : ThresholdRule​

List of the ThresholdRule. Rules define intermediate cost thresholds of the budget.

filter : ConsumptionFilter​

Filter that can be used for specific resources selection. Only consumption cost of selected resources are used for the budget calculation.

One of startType​

Start type of the budget.

  • resetPeriod : ResetPeriodType​
    Periodic start type that resets budget after specified period is finished.

    First time budget is calculated in the current period, i.e. current month, quarter or year.

  • startDate : string​
    Custom start date of the budget.

    Must be the first day of a month and must be formatted like YYYY-MM-DD.

endDate : string​

End date of the budget. Must be the last day of a month and must be formatted like YYYY-MM-DD.

Customer​

A Customer resource.

id : string​

ID of the customer.

billingAccountId : string​

ID of the yandex.cloud.billing.v1.BillingAccount assigned to the customer.

CustomerPerson​

Person of the customer. Contains legal information.

name : string​

Optional. Name of the person.

String length is not limited.

longname : string​

Optional. Long name of the person.

String length is not limited.

phone : string​

Optional. Phone of the person.

Must be a valid telephone number or a valid phoneword.

email : string​

Optional. Email of the person.

Must be a valid email address.

postCode : string​

Optional. Post code of the person.

String length is not limited.

postAddress : string​

Optional. Post address of the person.

String length is not limited.

legalAddress : string​

Optional. Legal address of the person.

String length is not limited.

tin : string​

Optional. Tax identification number of the person.

String length is not limited.

ExpenseBudgetSpec​

Expense budget specification describes budget that can be used to control expense of cloud resources usage.

amount : string​

Max expense threshold of the budget. Amount currency is the same as corresponding yandex.cloud.billing.v1.BillingAccount.currency.

notificationUserAccountIds : string​

IDs of the yandex.cloud.iam.v1.UserAccount. Specified users will be be notified if the budget exceeds.

thresholdRules : ThresholdRule​

List of the ThresholdRule. Rules define intermediate expense thresholds of the budget.

filter : ConsumptionFilter​

Filter that can be used for specific resources selection. Only consumption expense of selected resources are used for the budget calculation.

  • resetPeriod : ResetPeriodType​
    Periodic start type that resets budget after specified period is finished.

    First time budget is calculated in the current period, i.e. current month, quarter or year.

  • startDate : string​
    Custom start date of the budget.

    Must be the first day of a month and must be formatted like YYYY-MM-DD.

endDate : string​

End date of the budget. Must be the last day of a month and must be formatted like YYYY-MM-DD.

PricingExpression​

Pricing expression of the pricing version. Defines price for the sku.

rates : Rate​

List of rates.

PricingVersion​

Pricing version of the SKU. Defines current and past prices for the sku.

type : PricingVersionType​

Type of the pricing version.

effectiveTime : google.protobuf.Timestamp​

Timestamp pricing version is active since inclusive. The pricing version is active until next pricing version effective time exclusive.

pricingExpressions : PricingExpression​

List of pricing expressions.

Rate​

Rate of the pricing expression. Define unit price for pricing quantity interval.

startPricingQuantity : string​

Start of the pricing quantity interval. The end of the interval is the start pricing quantity of the next rate.

unitPrice : string​

Unit price for the pricing quantity interval.

currency : string​

Currency of the unit price. Can be one of the following:

  • RUB
  • USD
  • KZT

Service​

A Service resource.

id : string​

ID of the service.

name : string​

Name of the service, e.g. Compute Cloud, VPC.

description : string​

Description of the service.

Sku​

A Stock keeping unit resource.

id : string​

ID of the SKU.

name : string​

Name of the SKU.

description : string​

Description of the sku.

serviceId : string​

ID of the service that sku belongs to.

pricingUnit : string​

Pricing unit of the SKU, e.g. core*hour, gbyte*hour.

pricingVersions : PricingVersion​

List of pricing versions.

ThresholdRule​

Rules that define intermediate cost thresholds of the budget.

type : ThresholdType​

Type of the rule.

amount : string​

Amount of the rule.

  • Must be less than 100 if type is PERCENT.
  • Must be less than budget's amount if type is AMOUNT.
notificationUserAccountIds : string​

IDs of the yandex.cloud.iam.v1.UserAccount. Specified users will be be notified if the threshold exceeds.