Class ProductCatalogSKUDataAttributesResponse

The pricing and allotment metadata of a SKU.

Hierarchy

  • ProductCatalogSKUDataAttributesResponse

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

The allotments the SKU provides to other SKUs. Every entry carries the code of this SKU as its parent_sku_code. Empty when the SKU provides no allotments.

billingDimension: string

The identifier of the billing dimension the SKU is billed on, as used by the usage metering endpoints. Several SKUs can share one billing dimension, so this value does not identify a SKU.

billingUnits: null | string

The billable usage unit the SKU is priced per. null for SKUs that are not priced per unit of usage, such as those whose pricing_type is percent.

currency: string

The ISO-4217 code of the currency the prices are expressed in.

defaultOnDemandOption: ProductCatalogSKUOnDemandOption

The billing frequency applied to on-demand usage of the SKU by default.

numberOfUnitsIncludedInPrice: number

The number of billable usage units that one unit of price covers. Divide measured usage by this value before multiplying by the price. For example, a SKU priced at 18.00 with number_of_units_included_in_price of 1 costs 18.00 per host, while a SKU priced at 12.00 with number_of_units_included_in_price of 10000 costs 12.00 per 10,000 requests. It is a scaling factor on the price, not a free allotment; included quantities are in allotments. The same factor applies to the price of a tier in on_demand_tiered whose pricing_unit_type is unit. It does not apply to a tier whose pricing_unit_type is block: that tier's price is charged for the whole block bounded by min_usage_quantity and max_usage_quantity, however much of the block is used. 0 for SKUs that are not priced per unit of usage, such as those whose pricing_type is percent.

onDemandListPrice: null | string

The public list price of on-demand usage of the SKU, as a decimal string. The number of decimal places is not normalized, so values such as 0, 0.9, and 30000.00 all occur. null when the SKU is priced with tiers, in which case the prices are in on_demand_tiered.

onDemandTiered: null | ProductCatalogSKUTieredPricing

The tiered pricing applied to on-demand usage of the SKU. null when the SKU is priced with a single list price instead.

How the SKU is priced. usage prices each billable usage unit, and percent prices a percentage; percent-priced SKUs have no billing_units.

skuName: string

The human-readable name of the SKU.

Generated using TypeDoc