Package com.softlayer.api.service.product.item

Class Price

  • @ApiType("SoftLayer_Product_Item_Price")
public class Price
extends Entity
    The SoftLayer_Product_Item_Price data type contains general information relating to a single SoftLayer product item price. You can find out what packages each price is in as well as which category under which this price is sold. All prices are returned in floating point values measured in US Dollars ($USD).
    See Also:
    SoftLayer_Product_Item_Price

    • Field Detail

      • bareMetalReservedCapacityFlag

        @ApiProperty
protected Boolean bareMetalReservedCapacityFlag
        Signifies pricing that is only available on a bare metal reserved capacity order.

      • bigDataOsJournalDiskFlag

        @ApiProperty
protected Boolean bigDataOsJournalDiskFlag
        Whether the price is for Big Data OS/Journal disks only. (Deprecated)

      • capacityRestrictionMaximum

        @ApiProperty
protected String capacityRestrictionMaximum
        The maximum capacity value for which this price is suitable.

      • capacityRestrictionMinimum

        @ApiProperty
protected String capacityRestrictionMinimum
        The minimum capacity value for which this price is suitable.

      • capacityRestrictionType

        @ApiProperty
protected String capacityRestrictionType
        The type of capacity restriction by which this price must abide.

      • dedicatedHostInstanceFlag

        @ApiProperty
protected Boolean dedicatedHostInstanceFlag
        Signifies pricing that is only available on a dedicated host virtual server order.

      • definedSoftwareLicenseFlag

        @ApiProperty
protected Boolean definedSoftwareLicenseFlag
        Whether this price defines a software license for its product item.

      • eligibilityStrategy

        @ApiProperty
protected String eligibilityStrategy
        Eligibility strategy to assess if a customer can order using this price.

      • priceType

        @ApiProperty
protected String priceType
        The type keyname of this price which can be STANDARD, TIERED, or TERM.

      • pricingLocationGroup

        @ApiProperty
protected Pricing pricingLocationGroup
        The pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group.

      • requiredCoreCount

        @ApiProperty
protected Long requiredCoreCount
        The number of server cores required to order this item. This is deprecated. Use [[SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum|getCapacityRestrictionMinimum]] and [[SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum|getCapacityRestrictionMaximum]]

      • reservedCapacityInstanceFlag

        @ApiProperty
protected Boolean reservedCapacityInstanceFlag
        Signifies pricing that is only available on a reserved capacity virtual server order.

      • currentPriceFlag

        @ApiProperty(canBeNullOrNotSet=true)
protected Boolean currentPriceFlag
        This flag is used by the getUpgradeItemPrices methods available on various resources to indicate if a product price is used for the current billing item.

      • currentPriceFlagSpecified

        protected boolean currentPriceFlagSpecified

      • hourlyRecurringFeeSpecified

        protected boolean hourlyRecurringFeeSpecified

      • idSpecified

        protected boolean idSpecified

      • itemIdSpecified

        protected boolean itemIdSpecified

      • laborFeeSpecified

        protected boolean laborFeeSpecified

      • locationGroupId

        @ApiProperty(canBeNullOrNotSet=true)
protected Long locationGroupId
        The id of the [[SoftLayer_Location_Group_Pricing]] that this price is part of. If set to null, the price is considered a standard price, which can be used with any location when ordering.

        During order [[SoftLayer_Product_Order/verifyOrder|verification]] and [[SoftLayer_Product_Order/placeOrder|placement]], if a standard price is used, that price may be replaced with a location based price, which does not have this property set to null. The location based price must be part of a [[SoftLayer_Location_Group_Pricing]] that has the location being ordered in order for this to happen.

      • locationGroupIdSpecified

        protected boolean locationGroupIdSpecified

      • onSaleFlagSpecified

        protected boolean onSaleFlagSpecified

      • oneTimeFeeSpecified

        protected boolean oneTimeFeeSpecified

      • oneTimeFeeTax

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal oneTimeFeeTax
        A price's total tax amount of the one time fees (oneTimeFee, laborFee, and setupFee). This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()

      • oneTimeFeeTaxSpecified

        protected boolean oneTimeFeeTaxSpecified

      • orderOptionsSpecified

        protected boolean orderOptionsSpecified

      • proratedRecurringFee

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal proratedRecurringFee
        A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD).

      • proratedRecurringFeeSpecified

        protected boolean proratedRecurringFeeSpecified

      • proratedRecurringFeeTax

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal proratedRecurringFeeTax
        A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()

      • proratedRecurringFeeTaxSpecified

        protected boolean proratedRecurringFeeTaxSpecified

      • quantitySpecified

        protected boolean quantitySpecified

      • recurringFee

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal recurringFee
        A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD).

      • recurringFeeSpecified

        protected boolean recurringFeeSpecified

      • recurringFeeTax

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal recurringFeeTax
        A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()

      • recurringFeeTaxSpecified

        protected boolean recurringFeeTaxSpecified

      • setupFeeSpecified

        protected boolean setupFeeSpecified

      • sortSpecified

        protected boolean sortSpecified

      • termLengthSpecified

        protected boolean termLengthSpecified

      • tierMinimumThreshold

        @ApiProperty(canBeNullOrNotSet=true)
protected Long tierMinimumThreshold
        The minimum threshold for which this tiered usage price begins to apply. The unit for the price is defined by the item to which this belongs, see [[SoftLayer_Product_Item::$units]].

      • tierMinimumThresholdSpecified

        protected boolean tierMinimumThresholdSpecified

      • usageRateSpecified

        protected boolean usageRateSpecified

      • accountRestrictionCount

        @ApiProperty
protected Long accountRestrictionCount
        A count of the account that the item price is restricted to.

      • bundleReferenceCount

        @ApiProperty
protected Long bundleReferenceCount
        A count of cross reference for bundles

      • categoryCount

        @ApiProperty
protected Long categoryCount
        A count of all categories which this item is a member.

      • packageCount

        @ApiProperty
protected Long packageCount
        A count of a price's packages under which this item is sold.

      • packageReferenceCount

        @ApiProperty
protected Long packageReferenceCount
        A count of cross reference for packages

      • presetConfigurationCount

        @ApiProperty
protected Long presetConfigurationCount
        A count of a list of preset configurations this price is used in.'

    • Constructor Detail

      • Price

        public Price()

    • Method Detail

      • getAccountRestrictions

        public List<Restriction> getAccountRestrictions()

      • getBareMetalReservedCapacityFlag

        public Boolean getBareMetalReservedCapacityFlag()

      • setBareMetalReservedCapacityFlag

        public void setBareMetalReservedCapacityFlag​(Boolean bareMetalReservedCapacityFlag)

      • getBigDataOsJournalDiskFlag

        public Boolean getBigDataOsJournalDiskFlag()

      • setBigDataOsJournalDiskFlag

        public void setBigDataOsJournalDiskFlag​(Boolean bigDataOsJournalDiskFlag)

      • getBundleReferences

        public List<Bundles> getBundleReferences()

      • getCapacityRestrictionMaximum

        public String getCapacityRestrictionMaximum()

      • setCapacityRestrictionMaximum

        public void setCapacityRestrictionMaximum​(String capacityRestrictionMaximum)

      • getCapacityRestrictionMinimum

        public String getCapacityRestrictionMinimum()

      • setCapacityRestrictionMinimum

        public void setCapacityRestrictionMinimum​(String capacityRestrictionMinimum)

      • getCapacityRestrictionType

        public String getCapacityRestrictionType()

      • setCapacityRestrictionType

        public void setCapacityRestrictionType​(String capacityRestrictionType)

      • getDedicatedHostInstanceFlag

        public Boolean getDedicatedHostInstanceFlag()

      • setDedicatedHostInstanceFlag

        public void setDedicatedHostInstanceFlag​(Boolean dedicatedHostInstanceFlag)

      • getDefinedSoftwareLicenseFlag

        public Boolean getDefinedSoftwareLicenseFlag()

      • setDefinedSoftwareLicenseFlag

        public void setDefinedSoftwareLicenseFlag​(Boolean definedSoftwareLicenseFlag)

      • getEligibilityStrategy

        public String getEligibilityStrategy()

      • setEligibilityStrategy

        public void setEligibilityStrategy​(String eligibilityStrategy)

      • getItem

        public Item getItem()

      • setItem

        public void setItem​(Item item)

      • getOrderPremiums

        public List<Premium> getOrderPremiums()

      • getPackageReferences

        public List<Prices> getPackageReferences()

      • getPriceType

        public String getPriceType()

      • setPriceType

        public void setPriceType​(String priceType)

      • getPricingLocationGroup

        public Pricing getPricingLocationGroup()

      • setPricingLocationGroup

        public void setPricingLocationGroup​(Pricing pricingLocationGroup)

      • getRequiredCoreCount

        public Long getRequiredCoreCount()

      • setRequiredCoreCount

        public void setRequiredCoreCount​(Long requiredCoreCount)

      • getReservedCapacityInstanceFlag

        public Boolean getReservedCapacityInstanceFlag()

      • setReservedCapacityInstanceFlag

        public void setReservedCapacityInstanceFlag​(Boolean reservedCapacityInstanceFlag)

      • getCurrentPriceFlag

        public Boolean getCurrentPriceFlag()

      • setCurrentPriceFlag

        public void setCurrentPriceFlag​(Boolean currentPriceFlag)

      • isCurrentPriceFlagSpecified

        public boolean isCurrentPriceFlagSpecified()

      • unsetCurrentPriceFlag

        public void unsetCurrentPriceFlag()

      • getHourlyRecurringFee

        public BigDecimal getHourlyRecurringFee()

      • setHourlyRecurringFee

        public void setHourlyRecurringFee​(BigDecimal hourlyRecurringFee)

      • isHourlyRecurringFeeSpecified

        public boolean isHourlyRecurringFeeSpecified()

      • unsetHourlyRecurringFee

        public void unsetHourlyRecurringFee()

      • getId

        public Long getId()

      • setId

        public void setId​(Long id)

      • isIdSpecified

        public boolean isIdSpecified()

      • unsetId

        public void unsetId()

      • getItemId

        public Long getItemId()

      • setItemId

        public void setItemId​(Long itemId)

      • isItemIdSpecified

        public boolean isItemIdSpecified()

      • unsetItemId

        public void unsetItemId()

      • setLaborFee

        public void setLaborFee​(BigDecimal laborFee)

      • isLaborFeeSpecified

        public boolean isLaborFeeSpecified()

      • unsetLaborFee

        public void unsetLaborFee()

      • getLocationGroupId

        public Long getLocationGroupId()

      • setLocationGroupId

        public void setLocationGroupId​(Long locationGroupId)

      • isLocationGroupIdSpecified

        public boolean isLocationGroupIdSpecified()

      • unsetLocationGroupId

        public void unsetLocationGroupId()

      • getOnSaleFlag

        public Boolean getOnSaleFlag()

      • setOnSaleFlag

        public void setOnSaleFlag​(Boolean onSaleFlag)

      • isOnSaleFlagSpecified

        public boolean isOnSaleFlagSpecified()

      • unsetOnSaleFlag

        public void unsetOnSaleFlag()

      • getOneTimeFee

        public BigDecimal getOneTimeFee()

      • setOneTimeFee

        public void setOneTimeFee​(BigDecimal oneTimeFee)

      • isOneTimeFeeSpecified

        public boolean isOneTimeFeeSpecified()

      • unsetOneTimeFee

        public void unsetOneTimeFee()

      • getOneTimeFeeTax

        public BigDecimal getOneTimeFeeTax()

      • setOneTimeFeeTax

        public void setOneTimeFeeTax​(BigDecimal oneTimeFeeTax)

      • isOneTimeFeeTaxSpecified

        public boolean isOneTimeFeeTaxSpecified()

      • unsetOneTimeFeeTax

        public void unsetOneTimeFeeTax()

      • getOrderOptions

        public List<Type> getOrderOptions()

      • isOrderOptionsSpecified

        public boolean isOrderOptionsSpecified()

      • unsetOrderOptions

        public void unsetOrderOptions()

      • getProratedRecurringFee

        public BigDecimal getProratedRecurringFee()

      • setProratedRecurringFee

        public void setProratedRecurringFee​(BigDecimal proratedRecurringFee)

      • isProratedRecurringFeeSpecified

        public boolean isProratedRecurringFeeSpecified()

      • unsetProratedRecurringFee

        public void unsetProratedRecurringFee()

      • getProratedRecurringFeeTax

        public BigDecimal getProratedRecurringFeeTax()

      • setProratedRecurringFeeTax

        public void setProratedRecurringFeeTax​(BigDecimal proratedRecurringFeeTax)

      • isProratedRecurringFeeTaxSpecified

        public boolean isProratedRecurringFeeTaxSpecified()

      • unsetProratedRecurringFeeTax

        public void unsetProratedRecurringFeeTax()

      • getQuantity

        public Long getQuantity()

      • setQuantity

        public void setQuantity​(Long quantity)

      • isQuantitySpecified

        public boolean isQuantitySpecified()

      • unsetQuantity

        public void unsetQuantity()

      • getRecurringFee

        public BigDecimal getRecurringFee()

      • setRecurringFee

        public void setRecurringFee​(BigDecimal recurringFee)

      • isRecurringFeeSpecified

        public boolean isRecurringFeeSpecified()

      • unsetRecurringFee

        public void unsetRecurringFee()

      • getRecurringFeeTax

        public BigDecimal getRecurringFeeTax()

      • setRecurringFeeTax

        public void setRecurringFeeTax​(BigDecimal recurringFeeTax)

      • isRecurringFeeTaxSpecified

        public boolean isRecurringFeeTaxSpecified()

      • unsetRecurringFeeTax

        public void unsetRecurringFeeTax()

      • setSetupFee

        public void setSetupFee​(BigDecimal setupFee)

      • isSetupFeeSpecified

        public boolean isSetupFeeSpecified()

      • unsetSetupFee

        public void unsetSetupFee()

      • getSort

        public Long getSort()

      • setSort

        public void setSort​(Long sort)

      • isSortSpecified

        public boolean isSortSpecified()

      • unsetSort

        public void unsetSort()

      • getTermLength

        public Long getTermLength()

      • setTermLength

        public void setTermLength​(Long termLength)

      • isTermLengthSpecified

        public boolean isTermLengthSpecified()

      • unsetTermLength

        public void unsetTermLength()

      • getTierMinimumThreshold

        public Long getTierMinimumThreshold()

      • setTierMinimumThreshold

        public void setTierMinimumThreshold​(Long tierMinimumThreshold)

      • isTierMinimumThresholdSpecified

        public boolean isTierMinimumThresholdSpecified()

      • unsetTierMinimumThreshold

        public void unsetTierMinimumThreshold()

      • setUsageRate

        public void setUsageRate​(BigDecimal usageRate)

      • isUsageRateSpecified

        public boolean isUsageRateSpecified()

      • unsetUsageRate

        public void unsetUsageRate()

      • getAccountRestrictionCount

        public Long getAccountRestrictionCount()

      • setAccountRestrictionCount

        public void setAccountRestrictionCount​(Long accountRestrictionCount)

      • getAttributeCount

        public Long getAttributeCount()

      • setAttributeCount

        public void setAttributeCount​(Long attributeCount)

      • getBundleReferenceCount

        public Long getBundleReferenceCount()

      • setBundleReferenceCount

        public void setBundleReferenceCount​(Long bundleReferenceCount)

      • getCategoryCount

        public Long getCategoryCount()

      • setCategoryCount

        public void setCategoryCount​(Long categoryCount)

      • getOrderPremiumCount

        public Long getOrderPremiumCount()

      • setOrderPremiumCount

        public void setOrderPremiumCount​(Long orderPremiumCount)

      • getPackageCount

        public Long getPackageCount()

      • setPackageCount

        public void setPackageCount​(Long packageCount)

      • getPackageReferenceCount

        public Long getPackageReferenceCount()

      • setPackageReferenceCount

        public void setPackageReferenceCount​(Long packageReferenceCount)

      • getPresetConfigurationCount

        public Long getPresetConfigurationCount()

      • setPresetConfigurationCount

        public void setPresetConfigurationCount​(Long presetConfigurationCount)