REST Resource: billingAccounts.skus.price

Resource: BillingAccountPrice

Encapsulates the latest price for a billing account SKU.

JSON representation
{
  "name": string,
  "currencyCode": string,
  "valueType": string,
  "priceReason": {
    object (PriceReason)
  },

  // Union field value can be only one of the following:
  "rate": {
    object (Rate)
  }
  // End of list of possible types for union field value.
}
Fields
name

string

Resource name for the latest billing account price.

currencyCode

string

ISO-4217 currency code for the price.

valueType

string

Type of the price. The possible values are: ["unspecified", "rate"].

priceReason

object (PriceReason)

Background information on the origin of the price.

Union field value.

value can be only one of the following:

rate

object (Rate)

Rate price metadata. Billing account SKUs with Rate price are offered by pricing tiers. The price can have 1 or more rate pricing tiers.

Rate

Encapsulates a Rate price. Billing account SKUs with Rate price are offered by pricing tiers. The price have 1 or more rate pricing tiers.

JSON representation
{
  "tiers": [
    {
      object (RateTier)
    }
  ],
  "unitInfo": {
    object (UnitInfo)
  },
  "aggregationInfo": {
    object (AggregationInfo)
  }
}
Fields
tiers[]

object (RateTier)

All tiers associated with the Rate price.

unitInfo

object (UnitInfo)

Unit info such as name and quantity.

aggregationInfo

object (AggregationInfo)

Aggregation info for tiers such as aggregation level and interval.

RateTier

Encapsulates a rate price tier.

JSON representation
{
  "startAmount": {
    object (Decimal)
  },
  "listPrice": {
    object (Money)
  },
  "contractPrice": {
    object (Money)
  },
  "effectiveDiscountPercent": {
    object (Decimal)
  }
}
Fields
startAmount

object (Decimal)

Lower bound amount for a tier. Tiers 0-100, 100-200 will be represented with two tiers with startAmount 0 and 100.

listPrice

object (Money)

List price of one tier.

contractPrice

object (Money)

Negotiated contract price specific for a billing account.

effectiveDiscountPercent

object (Decimal)

Percentage of effective discount calculated using the current list price per pricing tier. Formula used: effectiveDiscountPercent = (listPrice - contractPrice) / listPrice × 100 If listPrice and contractPrice are zero, this field is the same as discountPercent of FixedDiscount and FloatingDiscount. If your contract does NOT have the feature LIST_PRICE_AS_CEILING enabled, the effectiveDiscountPercent can be negative if the SKU has a FixedDiscount and the current list price is lower than the list price on the date of the contract agreement. See the FixedDiscount.fix_time on when the discount was set. If you have questions regarding pricing per SKU, contact your Account team for more details.

UnitInfo

Encapsulates the unit information for a Rate

JSON representation
{
  "unit": string,
  "unitDescription": string,
  "unitQuantity": {
    object (Decimal)
  }
}
Fields
unit

string

Shorthand for the unit. Example: GiBy.mo.

unitDescription

string

Human-readable description of the unit. Example: gibibyte month.

unitQuantity

object (Decimal)

Unit quantity for the tier. Example: if the RateTier price is $1 per 1000000 Bytes, then unitQuantity is set to 1000000.

AggregationInfo

Encapsulates the aggregation information such as aggregation level and interval for a billing account price.

JSON representation
{
  "level": enum (Level),
  "interval": enum (Interval)
}
Fields
level

enum (Level)

Level at which usage is aggregated to compute cost. Example: "ACCOUNT" level indicates that usage is aggregated across all projects in a single account.

interval

enum (Interval)

Interval at which usage is aggregated to compute cost. Example: "MONTHLY" interval indicates that usage is aggregated every month.

Level

Different aggregation levels.

Enums
LEVEL_UNSPECIFIED Default unspecified value.
LEVEL_ACCOUNT Usage is aggregated at an account level.
LEVEL_PROJECT Usage is aggregated at a project level.

Interval

Different aggregation intervals.

Enums
INTERVAL_UNSPECIFIED Default unspecified value.
INTERVAL_MONTHLY Usage is aggregated every month.
INTERVAL_DAILY Usage is aggregated every day.

PriceReason

Encapsulates a price reason which contains background information about the origin of the price.

JSON representation
{
  "type": string,

  // Union field metadata can be only one of the following:
  "defaultPrice": {
    object (DefaultPrice)
  },
  "fixedPrice": {
    object (FixedPrice)
  },
  "fixedDiscount": {
    object (FixedDiscount)
  },
  "floatingDiscount": {
    object (FloatingDiscount)
  },
  "migratedPrice": {
    object (MigratedPrice)
  },
  "mergedPrice": {
    object (MergedPrice)
  },
  "listPriceAsCeiling": {
    object (ListPriceAsCeiling)
  }
  // End of list of possible types for union field metadata.
}
Fields
type

string

Type of the price reason. It can have values such as 'unspecified', 'default-price', 'fixed-price', 'fixed-discount', 'floating-discount', 'migrated-price', 'merged-price', 'list-price-as-ceiling'.

Union field metadata.

metadata can be only one of the following:

defaultPrice

object (DefaultPrice)

Default price which is the current list price.

fixedPrice

object (FixedPrice)

Fixed price applicable during the terms of a contract agreement.

fixedDiscount

object (FixedDiscount)

Discount off the list price, anchored to the list price as of a fixed time.

floatingDiscount

object (FloatingDiscount)

Discount off the current list price, not anchored to any list price as of a fixed time.

migratedPrice

object (MigratedPrice)

Price migrated from other SKUs.

mergedPrice

object (MergedPrice)

Price after merging from multiple sources.

listPriceAsCeiling

object (ListPriceAsCeiling)

Contract feature that the list price (DefaultPrice) will be used for the price if the current list price drops lower than the custom fixed price. Available to new contracts after March 21, 2022. Applies to all fixed price SKUs in the contract, including FixedPrice, FixedDiscount, MigratedPrice, and MergedPrice.

DefaultPrice

This type has no fields.

Encapsulates a default price which is the current list price.

FixedPrice

This type has no fields.

Encapsulates a set fixed price applicable during the terms of a contract agreement.

FixedDiscount

Encapsulates a discount off the list price, anchored to the list price as of a fixed time.

JSON representation
{
  "discountPercent": {
    object (Decimal)
  },
  "fixTime": string,
  "discountScopeType": string,

  // Union field discount_scope can be only one of the following:
  "skuGroup": string
  // End of list of possible types for union field discount_scope.
}
Fields
discountPercent

object (Decimal)

Percentage of the fixed discount.

fixTime

string (Timestamp format)

Time that the fixed discount is anchored to.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

discountScopeType

string

Type of the fixed discount scope which indicates the source of the discount. It can have values such as 'unspecified' and 'sku-group'.

Union field discount_scope.

discount_scope can be only one of the following:

skuGroup

string

SKU group where the fixed discount comes from.

FloatingDiscount

Encapsulates a discount off the current list price, not anchored to any list price as of a fixed time.

JSON representation
{
  "discountPercent": {
    object (Decimal)
  },
  "discountScopeType": string,

  // Union field discount_scope can be only one of the following:
  "skuGroup": string
  // End of list of possible types for union field discount_scope.
}
Fields
discountPercent

object (Decimal)

Percentage of the floating discount.

discountScopeType

string

Type of the floating discount scope which indicates the source of the discount. It can have values such as 'unspecified' and 'sku-group'.

Union field discount_scope.

discount_scope can be only one of the following:

skuGroup

string

SKU group where the floating discount comes from.

MigratedPrice

Encapsulates a price migrated from other SKUs.

JSON representation
{
  "sourceSku": string
}
Fields
sourceSku

string

Source SKU where the discount is migrated from. Format: billingAccounts/{billingAccount}/skus/{sku}

MergedPrice

This type has no fields.

Encapsulates a price after merging from multiple sources. With merged tiers, each individual tier can be from a different source with different discount types.

ListPriceAsCeiling

This type has no fields.

Encapsulates a contract feature that the list price (DefaultPrice) will be used for the price if the current list price drops lower than the custom fixed price. Available to new contracts after March 21, 2022. Applies to all fixed price SKUs in the contract, including FixedPrice, FixedDiscount, MigratedPrice, and MergedPrice.

Methods

get

Gets the latest price for SKUs available to your Cloud Billing account.