CustomPriceProperties interface

Custom price properties for a given discount.

Properties

billingPeriod

The billing period of the priceable node. Validation: Optional, Maximum length 128 characters. Only allowed if the availability derived by market, product, sku, and claims has terms and at least one of those terms has a billing period. When specified, termUnits must be specified.

catalogClaims

The set of BigCat claims. Validation: Required. Must contain AgreementType, NationalCloud, and PricingAudience claims. Additionally requires AccessPass claim when creating custom price with action == consume on the pricing instructions.

catalogId

The catalog instance where the priceable node lives. Validation: Required. No defined format, will vary per team.

marketSetPrices

The set of market set prices of the priceable node. Validation: Required. Must contain at least one element.

meterType

Must be present if the market, product, sku, and claims, and optional term information resolves to multiple availabilities that only differ by meter type. Validation: Maximum length 128 characters.

ruleType

The type of the priceable node pricing rule. Validation: Required. Supported values are fixedPriceLock, fixedListPrice, and priceCeiling.

termUnits

The term units for the priceable node. Validation: Optional, Maximum length 128 characters. Must be present if and only if the availability derived by market, product, sku, and claims has terms.

Property Details

billingPeriod

The billing period of the priceable node. Validation: Optional, Maximum length 128 characters. Only allowed if the availability derived by market, product, sku, and claims has terms and at least one of those terms has a billing period. When specified, termUnits must be specified.

billingPeriod?: string

Property Value

string

catalogClaims

The set of BigCat claims. Validation: Required. Must contain AgreementType, NationalCloud, and PricingAudience claims. Additionally requires AccessPass claim when creating custom price with action == consume on the pricing instructions.

catalogClaims: CatalogClaimsItem[]

Property Value

catalogId

The catalog instance where the priceable node lives. Validation: Required. No defined format, will vary per team.

catalogId: string

Property Value

string

marketSetPrices

The set of market set prices of the priceable node. Validation: Required. Must contain at least one element.

marketSetPrices: MarketSetPricesItems[]

Property Value

meterType

Must be present if the market, product, sku, and claims, and optional term information resolves to multiple availabilities that only differ by meter type. Validation: Maximum length 128 characters.

meterType?: string

Property Value

string

ruleType

The type of the priceable node pricing rule. Validation: Required. Supported values are fixedPriceLock, fixedListPrice, and priceCeiling.

ruleType: string

Property Value

string

termUnits

The term units for the priceable node. Validation: Optional, Maximum length 128 characters. Must be present if and only if the availability derived by market, product, sku, and claims has terms.

termUnits?: string

Property Value

string