Class CcdOffer

The created CCD offer details.

Inheritance

object

CcdOffer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CcdoffersService.Models

Assembly: OCI.DotNetSDK.Ccdoffers.dll

Syntax

public class CcdOffer

Properties

BundleSkus

Declaration

[JsonProperty(PropertyName = "bundleSkus")]
public List<BundleSku> BundleSkus { get; set; }

Property Value

Type	Description
List<BundleSku>	The polymorphic bundled SKU definitions. Every bundled SKU in an offer must use the same quantityRule; don't mix FIXED_RATIO and CUSTOMER_SELECTED bundled SKUs in one offer. An offer can contain at most five SKUs in total, including the primary SKU.

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The root compartment OCID of the customer's tenancy if offer is dedicated to a particular customer only.

CreatedBy

Declaration

[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }

Property Value

Type	Description
string	Entity/User who created the ccdOffer.

CurrencyCode

Declaration

[JsonProperty(PropertyName = "currencyCode")]
public string CurrencyCode { get; set; }

Property Value

Type	Description
string	Currency code of listPrice associated with primary product/sku. This will be always null. Please refer externalPriceOfSku to know product/sku's associated list price in its currency code.

CustomerSegment

Declaration

[JsonProperty(PropertyName = "customerSegment")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CcdOffer.CustomerSegmentEnum? CustomerSegment { get; set; }

Property Value

Type	Description
CcdOffer.CustomerSegmentEnum?	The targeted customer segment.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DiscountPct

Declaration

[Required(ErrorMessage = "DiscountPct is required.")]
[JsonProperty(PropertyName = "discountPct")]
public string DiscountPct { get; set; }

Property Value

Type	Description
string	The discount percentage applicable to the CCD offer, represented as a decimal string from 0 through 100 inclusive.

Remarks

Required

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The CCD offer name.

Remarks

Required

ExternalPriceOfSku

Declaration

[JsonProperty(PropertyName = "externalPriceOfSku")]
public List<SkuExternalPriceModel> ExternalPriceOfSku { get; set; }

Property Value

Type	Description
List<SkuExternalPriceModel>	The SKU list price in all currency codes.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The CCD offer OCID.

Remarks

Required

IsFillerUsageEnable

Declaration

[JsonProperty(PropertyName = "isFillerUsageEnable")]
public bool? IsFillerUsageEnable { get; set; }

Property Value

Type	Description
bool?	Enable or disable filler usage if the customer usage quantity is below the minimum quantity, and you want metering to fill in usages to meet the minimum quantity.

LastUpdatedBy

Declaration

[JsonProperty(PropertyName = "lastUpdatedBy")]
public string LastUpdatedBy { get; set; }

Property Value

Type	Description
string	Entity/User who lastly updated the ccdOffer.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CcdOffer.LifecycleDetailsEnum? LifecycleDetails { get; set; }

Property Value

Type	Description
CcdOffer.LifecycleDetailsEnum?	The CCD offer's detailed current state. The state value is determined by timeCcdOfferStarts, timeCcdOfferEnds, and timeTerminated with respect to the current time.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CcdOffer.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
CcdOffer.LifecycleStateEnum?	Always defaults to Active. For the accurate resource state, refer to the lifecycleDetails property value.

ListPrice

Declaration

[JsonProperty(PropertyName = "listPrice")]
public string ListPrice { get; set; }

Property Value

Type	Description
string	ListPrice of a sku. Please refer externalPriceOfSku to know product/sku's associated list price in its currency code.

MaxQuantity

Declaration

[JsonProperty(PropertyName = "maxQuantity")]
public long? MaxQuantity { get; set; }

Property Value

Type	Description
long?	The maximum quantity of the primary SKU committed to the CCD offer. For FLEX offers if provided, it must equal minQuantity.

MinQuantity

Declaration

[Required(ErrorMessage = "MinQuantity is required.")]
[JsonProperty(PropertyName = "minQuantity")]
public long? MinQuantity { get; set; }

Property Value

Type	Description
long?	The minimum quantity of the primary SKU committed to the CCD offer. For FLEX offers, minQuantity and maxQuantity must both be equal if maxQuantity provided.

Remarks

Required

OfferRestriction

Declaration

[JsonProperty(PropertyName = "offerRestriction")]
public OfferRestriction OfferRestriction { get; set; }

Property Value

Type	Description
OfferRestriction

OrderDocumentNumber

Declaration

[JsonProperty(PropertyName = "orderDocumentNumber")]
public string OrderDocumentNumber { get; set; }

Property Value

Type	Description
string	Sales order document number.

ReclaimTerm

Declaration

[JsonProperty(PropertyName = "reclaimTerm")]
public long? ReclaimTerm { get; set; }

Property Value

Type	Description
long?	The reclaim term for an offer, measured in reclaimTermUnit.

ReclaimTermUnit

Declaration

[JsonProperty(PropertyName = "reclaimTermUnit")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CcdOffer.ReclaimTermUnitEnum? ReclaimTermUnit { get; set; }

Property Value

Type	Description
CcdOffer.ReclaimTermUnitEnum?	The unit used to measure reclaimTerm.

ReportingRegion

Declaration

[JsonProperty(PropertyName = "reportingRegion")]
public string ReportingRegion { get; set; }

Property Value

Type	Description
string	Defines where the filler usage is reported

Sku

Declaration

[Required(ErrorMessage = "Sku is required.")]
[JsonProperty(PropertyName = "sku")]
public string Sku { get; set; }

Property Value

Type	Description
string	The SKU part number (prefaced with "B") the CCD is associated with.

Remarks

Required

SkuDisplayName

Declaration

[Required(ErrorMessage = "SkuDisplayName is required.")]
[JsonProperty(PropertyName = "skuDisplayName")]
public string SkuDisplayName { get; set; }

Property Value

Type	Description
string	The canonical SKU display name.

Remarks

Required

SkuMetric

Declaration

[Required(ErrorMessage = "SkuMetric is required.")]
[JsonProperty(PropertyName = "skuMetric")]
public string SkuMetric { get; set; }

Property Value

Type	Description
string	The canonical billing metric.

Remarks

Required

SourceType

Declaration

[JsonProperty(PropertyName = "sourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CcdOffer.SourceTypeEnum? SourceType { get; set; }

Property Value

Type	Description
CcdOffer.SourceTypeEnum?	The commercial workflow that created the CCD offer/commitment. This value is immutable.

SubscriptionId

Declaration

[JsonProperty(PropertyName = "subscriptionId")]
public string SubscriptionId { get; set; }

Property Value

Type	Description
string	The subscription OCID if a this is dedicated CCD offer for a customer.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Term

Declaration

[Required(ErrorMessage = "Term is required.")]
[JsonProperty(PropertyName = "term")]
public int? Term { get; set; }

Property Value

Type	Description
int?	The number of terms the offer is applicable to.

Remarks

Required

TimeCcdOfferEnds

Declaration

[JsonProperty(PropertyName = "timeCcdOfferEnds")]
public DateTime? TimeCcdOfferEnds { get; set; }

Property Value

Type	Description
DateTime?	The inclusive time when the CCD offer is no longer in effect, and must be after timeCcdOfferStarts. The format is defined by RFC 3339.

TimeCcdOfferStarts

Declaration

[JsonProperty(PropertyName = "timeCcdOfferStarts")]
public DateTime? TimeCcdOfferStarts { get; set; }

Property Value

Type	Description
DateTime?	The inclusive date the CCD offer will be effective. The format is defined by RFC 3339.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Date and time the CCD was created. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

TimeTerminated

Declaration

[JsonProperty(PropertyName = "timeTerminated")]
public DateTime? TimeTerminated { get; set; }

Property Value

Type	Description
DateTime?	Date and time the CCD was terminated. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	Date and time the CCD was updated lastly. The format is defined by RFC 3339. Example: 2025-01-25T21:10:29.600Z

TypeOfOffer

Declaration

[JsonProperty(PropertyName = "typeOfOffer")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CcdOffer.TypeOfOfferEnum? TypeOfOffer { get; set; }

Property Value

Type	Description
CcdOffer.TypeOfOfferEnum?	The CCD offer type.

Unit

Declaration

[JsonProperty(PropertyName = "unit")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CcdOffer.UnitEnum? Unit { get; set; }

Property Value

Type	Description
CcdOffer.UnitEnum?	The term units.