Cloud Commerce Producer V1BETA API - Class Google::Cloud::CommerceProducer::V1beta::Sku::SkuPrice::TieredPrice (v0.1.0)

Reference documentation and code samples for the Cloud Commerce Producer V1BETA API class Google::Cloud::CommerceProducer::V1beta::Sku::SkuPrice::TieredPrice.

Price structure for a SKU charging a tiered price.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#price_tiers

def price_tiers() -> ::Array<::Google::Cloud::CommerceProducer::V1beta::Sku::SkuPrice::TieredPrice::PriceTier>
Returns
  • (::Array<::Google::Cloud::CommerceProducer::V1beta::Sku::SkuPrice::TieredPrice::PriceTier>) — Output only. The list of price tiers for the SKU, ordered by the start_amount.

    The tiers are non-overlapping and are collectively bounded below by zero and unbounded above to cover the entire range of possible metric usage. Each tier is bounded below inclusively by its start_amount and bounded above exclusively by the start_amount of the next tier, or else unbounded above if there is no next tier.

    Usage of the metric is aggregated by customer billing account on a monthly basis and billed in a graduated manner according to the price tiers, with each marginal unit of usage priced accoring to the tier in which it falls.

#price_unit_count

def price_unit_count() -> ::Google::Type::Decimal
Returns
  • (::Google::Type::Decimal) —

    Output only. Scaling the unit by the price_unit_count forms the composite "price unit" which is priced by the price tiers.

    This scaling factor is in addition to any numerical prefix symbol on the unit, so the same composite "price unit" can be represented in several ways, differing only in their presentation to users.

    Examples:

    • $1 per 1 bytes : unit = By, price_unit_count = 1
    • $1000 per 1 kilobytes : unit = kBy, price_unit_count = 1
    • $5000 per 5 kilobytes : unit = kBy, price_unit_count = 5

#unit

def unit() -> ::String
Returns
  • (::String) — Output only. Usage unit used for defining price tiers and for scaling with the price_unit_count to form the composite price unit.

    See https://ucum.org/ucum.html for the format of the price unit. A unitless dimension, such as a count, is represented as 1.

#unit_description

def unit_description() -> ::String
Returns
  • (::String) — Output only. The display description of the unit, supplied at time of onboarding. This value is recommended to be set at least for dimensionless metrics, but may be empty if no description was provided at time of onboarding.