CcdOffer¶

class oci.ccd_offers.models.CcdOffer(**kwargs)¶

Bases: object

The created CCD offer details.

Attributes

`CUSTOMER_SEGMENT_EXTERNAL`	A constant which can be used with the customer_segment property of a CcdOffer.
`CUSTOMER_SEGMENT_INTERNAL`	A constant which can be used with the customer_segment property of a CcdOffer.
`LIFECYCLE_DETAILS_CANCELED`	A constant which can be used with the lifecycle_details property of a CcdOffer.
`LIFECYCLE_DETAILS_CURRENT`	A constant which can be used with the lifecycle_details property of a CcdOffer.
`LIFECYCLE_DETAILS_ENDED`	A constant which can be used with the lifecycle_details property of a CcdOffer.
`LIFECYCLE_DETAILS_SCHEDULED`	A constant which can be used with the lifecycle_details property of a CcdOffer.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CcdOffer.
`RECLAIM_TERM_UNIT_DAYS`	A constant which can be used with the reclaim_term_unit property of a CcdOffer.
`SOURCE_TYPE_CONTRACT_COMMITMENT`	A constant which can be used with the source_type property of a CcdOffer.
`SOURCE_TYPE_CONTRACT_OFFER`	A constant which can be used with the source_type property of a CcdOffer.
`SOURCE_TYPE_FLEX`	A constant which can be used with the source_type property of a CcdOffer.
`SOURCE_TYPE_OCI_GENERATED`	A constant which can be used with the source_type property of a CcdOffer.
`TYPE_OF_OFFER_CONTRACTUAL`	A constant which can be used with the type_of_offer property of a CcdOffer.
`TYPE_OF_OFFER_CUSTOM`	A constant which can be used with the type_of_offer property of a CcdOffer.
`TYPE_OF_OFFER_FLEX`	A constant which can be used with the type_of_offer property of a CcdOffer.
`TYPE_OF_OFFER_PRIVATE`	A constant which can be used with the type_of_offer property of a CcdOffer.
`TYPE_OF_OFFER_STANDARD`	A constant which can be used with the type_of_offer property of a CcdOffer.
`UNIT_DAYS`	A constant which can be used with the unit property of a CcdOffer.
`UNIT_HOURS`	A constant which can be used with the unit property of a CcdOffer.
`UNIT_MONTHS`	A constant which can be used with the unit property of a CcdOffer.
`UNIT_YEARS`	A constant which can be used with the unit property of a CcdOffer.
`bundle_skus`	Gets the bundle_skus of this CcdOffer.
`compartment_id`	Gets the compartment_id of this CcdOffer.
`created_by`	Gets the created_by of this CcdOffer.
`currency_code`	Gets the currency_code of this CcdOffer.
`customer_segment`	Gets the customer_segment of this CcdOffer.
`defined_tags`	Gets the defined_tags of this CcdOffer.
`discount_pct`	[Required] Gets the discount_pct of this CcdOffer.
`display_name`	[Required] Gets the display_name of this CcdOffer.
`external_price_of_sku`	Gets the external_price_of_sku of this CcdOffer.
`freeform_tags`	Gets the freeform_tags of this CcdOffer.
`id`	[Required] Gets the id of this CcdOffer.
`is_filler_usage_enable`	Gets the is_filler_usage_enable of this CcdOffer.
`last_updated_by`	Gets the last_updated_by of this CcdOffer.
`lifecycle_details`	Gets the lifecycle_details of this CcdOffer.
`lifecycle_state`	Gets the lifecycle_state of this CcdOffer.
`list_price`	Gets the list_price of this CcdOffer.
`max_quantity`	Gets the max_quantity of this CcdOffer.
`min_quantity`	[Required] Gets the min_quantity of this CcdOffer.
`offer_restriction`	Gets the offer_restriction of this CcdOffer.
`order_document_number`	Gets the order_document_number of this CcdOffer.
`reclaim_term`	Gets the reclaim_term of this CcdOffer.
`reclaim_term_unit`	Gets the reclaim_term_unit of this CcdOffer.
`reporting_region`	Gets the reporting_region of this CcdOffer.
`sku`	[Required] Gets the sku of this CcdOffer.
`sku_display_name`	[Required] Gets the sku_display_name of this CcdOffer.
`sku_metric`	[Required] Gets the sku_metric of this CcdOffer.
`source_type`	Gets the source_type of this CcdOffer.
`subscription_id`	Gets the subscription_id of this CcdOffer.
`system_tags`	Gets the system_tags of this CcdOffer.
`term`	[Required] Gets the term of this CcdOffer.
`time_ccd_offer_ends`	Gets the time_ccd_offer_ends of this CcdOffer.
`time_ccd_offer_starts`	Gets the time_ccd_offer_starts of this CcdOffer.
`time_created`	Gets the time_created of this CcdOffer.
`time_terminated`	Gets the time_terminated of this CcdOffer.
`time_updated`	Gets the time_updated of this CcdOffer.
`type_of_offer`	Gets the type_of_offer of this CcdOffer.
`unit`	Gets the unit of this CcdOffer.

Methods

__init__(**kwargs) Initializes a new CcdOffer object with values from keyword arguments.

CUSTOMER_SEGMENT_EXTERNAL = 'EXTERNAL'¶: A constant which can be used with the customer_segment property of a CcdOffer. This constant has a value of “EXTERNAL”

CUSTOMER_SEGMENT_INTERNAL = 'INTERNAL'¶: A constant which can be used with the customer_segment property of a CcdOffer. This constant has a value of “INTERNAL”

LIFECYCLE_DETAILS_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_details property of a CcdOffer. This constant has a value of “CANCELED”

LIFECYCLE_DETAILS_CURRENT = 'CURRENT'¶: A constant which can be used with the lifecycle_details property of a CcdOffer. This constant has a value of “CURRENT”

LIFECYCLE_DETAILS_ENDED = 'ENDED'¶: A constant which can be used with the lifecycle_details property of a CcdOffer. This constant has a value of “ENDED”

LIFECYCLE_DETAILS_SCHEDULED = 'SCHEDULED'¶: A constant which can be used with the lifecycle_details property of a CcdOffer. This constant has a value of “SCHEDULED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a CcdOffer. This constant has a value of “ACTIVE”

RECLAIM_TERM_UNIT_DAYS = 'DAYS'¶: A constant which can be used with the reclaim_term_unit property of a CcdOffer. This constant has a value of “DAYS”

SOURCE_TYPE_CONTRACT_COMMITMENT = 'CONTRACT_COMMITMENT'¶: A constant which can be used with the source_type property of a CcdOffer. This constant has a value of “CONTRACT_COMMITMENT”

SOURCE_TYPE_CONTRACT_OFFER = 'CONTRACT_OFFER'¶: A constant which can be used with the source_type property of a CcdOffer. This constant has a value of “CONTRACT_OFFER”

SOURCE_TYPE_FLEX = 'FLEX'¶: A constant which can be used with the source_type property of a CcdOffer. This constant has a value of “FLEX”

SOURCE_TYPE_OCI_GENERATED = 'OCI_GENERATED'¶: A constant which can be used with the source_type property of a CcdOffer. This constant has a value of “OCI_GENERATED”

TYPE_OF_OFFER_CONTRACTUAL = 'CONTRACTUAL'¶: A constant which can be used with the type_of_offer property of a CcdOffer. This constant has a value of “CONTRACTUAL”

TYPE_OF_OFFER_CUSTOM = 'CUSTOM'¶: A constant which can be used with the type_of_offer property of a CcdOffer. This constant has a value of “CUSTOM”

TYPE_OF_OFFER_FLEX = 'FLEX'¶: A constant which can be used with the type_of_offer property of a CcdOffer. This constant has a value of “FLEX”

TYPE_OF_OFFER_PRIVATE = 'PRIVATE'¶: A constant which can be used with the type_of_offer property of a CcdOffer. This constant has a value of “PRIVATE”

TYPE_OF_OFFER_STANDARD = 'STANDARD'¶: A constant which can be used with the type_of_offer property of a CcdOffer. This constant has a value of “STANDARD”

UNIT_DAYS = 'DAYS'¶: A constant which can be used with the unit property of a CcdOffer. This constant has a value of “DAYS”

UNIT_HOURS = 'HOURS'¶: A constant which can be used with the unit property of a CcdOffer. This constant has a value of “HOURS”

UNIT_MONTHS = 'MONTHS'¶: A constant which can be used with the unit property of a CcdOffer. This constant has a value of “MONTHS”

UNIT_YEARS = 'YEARS'¶: A constant which can be used with the unit property of a CcdOffer. This constant has a value of “YEARS”

__init__(**kwargs)¶

Initializes a new CcdOffer object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this CcdOffer.
display_name (str) – The value to assign to the display_name property of this CcdOffer.
type_of_offer (str) – The value to assign to the type_of_offer property of this CcdOffer. Allowed values for this property are: “STANDARD”, “CUSTOM”, “PRIVATE”, “CONTRACTUAL”, “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
source_type (str) – The value to assign to the source_type property of this CcdOffer. Allowed values for this property are: “CONTRACT_COMMITMENT”, “CONTRACT_OFFER”, “FLEX”, “OCI_GENERATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
reclaim_term (int) – The value to assign to the reclaim_term property of this CcdOffer.
reclaim_term_unit (str) – The value to assign to the reclaim_term_unit property of this CcdOffer. Allowed values for this property are: “DAYS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
last_updated_by (str) – The value to assign to the last_updated_by property of this CcdOffer.
created_by (str) – The value to assign to the created_by property of this CcdOffer.
order_document_number (str) – The value to assign to the order_document_number property of this CcdOffer.
customer_segment (str) – The value to assign to the customer_segment property of this CcdOffer. Allowed values for this property are: “INTERNAL”, “EXTERNAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_filler_usage_enable (bool) – The value to assign to the is_filler_usage_enable property of this CcdOffer.
reporting_region (str) – The value to assign to the reporting_region property of this CcdOffer.
sku (str) – The value to assign to the sku property of this CcdOffer.
sku_display_name (str) – The value to assign to the sku_display_name property of this CcdOffer.
sku_metric (str) – The value to assign to the sku_metric property of this CcdOffer.
min_quantity (int) – The value to assign to the min_quantity property of this CcdOffer.
max_quantity (int) – The value to assign to the max_quantity property of this CcdOffer.
term (int) – The value to assign to the term property of this CcdOffer.
unit (str) – The value to assign to the unit property of this CcdOffer. Allowed values for this property are: “MONTHS”, “YEARS”, “DAYS”, “HOURS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
discount_pct (str) – The value to assign to the discount_pct property of this CcdOffer.
external_price_of_sku (list[oci.ccd_offers.models.SkuExternalPriceModel]) – The value to assign to the external_price_of_sku property of this CcdOffer.
offer_restriction (oci.ccd_offers.models.OfferRestriction) – The value to assign to the offer_restriction property of this CcdOffer.
bundle_skus (list[oci.ccd_offers.models.BundleSku]) – The value to assign to the bundle_skus property of this CcdOffer.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CcdOffer. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CcdOffer. Allowed values for this property are: “SCHEDULED”, “CURRENT”, “CANCELED”, “ENDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this CcdOffer.
time_terminated (datetime) – The value to assign to the time_terminated property of this CcdOffer.
time_updated (datetime) – The value to assign to the time_updated property of this CcdOffer.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CcdOffer.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CcdOffer.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CcdOffer.
time_ccd_offer_starts (datetime) – The value to assign to the time_ccd_offer_starts property of this CcdOffer.
time_ccd_offer_ends (datetime) – The value to assign to the time_ccd_offer_ends property of this CcdOffer.
currency_code (str) – The value to assign to the currency_code property of this CcdOffer.
list_price (str) – The value to assign to the list_price property of this CcdOffer.
subscription_id (str) – The value to assign to the subscription_id property of this CcdOffer.
compartment_id (str) – The value to assign to the compartment_id property of this CcdOffer.

bundle_skus¶

Gets the bundle_skus of this CcdOffer. 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.

Returns:	The bundle_skus of this CcdOffer.
Return type:	list[oci.ccd_offers.models.BundleSku]

compartment_id¶

Gets the compartment_id of this CcdOffer. The root compartment OCID of the customer’s tenancy if offer is dedicated to a particular customer only.

Returns:	The compartment_id of this CcdOffer.
Return type:	str

created_by¶

Gets the created_by of this CcdOffer. Entity/User who created the ccdOffer.

Returns:	The created_by of this CcdOffer.
Return type:	str

currency_code¶

Gets the currency_code of this CcdOffer. 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.

Returns:	The currency_code of this CcdOffer.
Return type:	str

customer_segment¶

Gets the customer_segment of this CcdOffer. The targeted customer segment.

Allowed values for this property are: “INTERNAL”, “EXTERNAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The customer_segment of this CcdOffer.
Return type:	str

defined_tags¶

Gets the defined_tags of this CcdOffer. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this CcdOffer.
Return type:	dict(str, dict(str, object))

discount_pct¶

[Required] Gets the discount_pct of this CcdOffer. The discount percentage applicable to the CCD offer, represented as a decimal string from 0 through 100 inclusive.

Returns:	The discount_pct of this CcdOffer.
Return type:	str

display_name¶

[Required] Gets the display_name of this CcdOffer. The CCD offer name.

Returns:	The display_name of this CcdOffer.
Return type:	str

external_price_of_sku¶

Gets the external_price_of_sku of this CcdOffer. The SKU list price in all currency codes.

Returns:	The external_price_of_sku of this CcdOffer.
Return type:	list[oci.ccd_offers.models.SkuExternalPriceModel]

freeform_tags¶

Gets the freeform_tags of this CcdOffer. 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”}

Returns:	The freeform_tags of this CcdOffer.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this CcdOffer. The CCD offer OCID.

Returns:	The id of this CcdOffer.
Return type:	str

is_filler_usage_enable¶

Gets the is_filler_usage_enable of this CcdOffer. 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.

Returns:	The is_filler_usage_enable of this CcdOffer.
Return type:	bool

last_updated_by¶

Gets the last_updated_by of this CcdOffer. Entity/User who lastly updated the ccdOffer.

Returns:	The last_updated_by of this CcdOffer.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this CcdOffer. The CCD offer’s detailed current state. The state value is determined by timeCcdOfferStarts, timeCcdOfferEnds, and timeTerminated with respect to the current time.

Allowed values for this property are: “SCHEDULED”, “CURRENT”, “CANCELED”, “ENDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_details of this CcdOffer.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this CcdOffer. Always defaults to Active. For the accurate resource state, refer to the lifecycleDetails property value.

Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this CcdOffer.
Return type:	str

list_price¶

Gets the list_price of this CcdOffer. ListPrice of a sku. Please refer externalPriceOfSku to know product/sku’s associated list price in its currency code.

Returns:	The list_price of this CcdOffer.
Return type:	str

max_quantity¶

Gets the max_quantity of this CcdOffer. The maximum quantity of the primary SKU committed to the CCD offer. For FLEX offers if provided, it must equal minQuantity.

Returns:	The max_quantity of this CcdOffer.
Return type:	int

min_quantity¶

[Required] Gets the min_quantity of this CcdOffer. 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.

Returns:	The min_quantity of this CcdOffer.
Return type:	int

offer_restriction¶

Gets the offer_restriction of this CcdOffer.

Returns:	The offer_restriction of this CcdOffer.
Return type:	oci.ccd_offers.models.OfferRestriction

order_document_number¶

Gets the order_document_number of this CcdOffer. Sales order document number.

Returns:	The order_document_number of this CcdOffer.
Return type:	str

reclaim_term¶

Gets the reclaim_term of this CcdOffer. The reclaim term for an offer, measured in reclaimTermUnit.

Returns:	The reclaim_term of this CcdOffer.
Return type:	int

reclaim_term_unit¶

Gets the reclaim_term_unit of this CcdOffer. The unit used to measure reclaimTerm.

Allowed values for this property are: “DAYS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The reclaim_term_unit of this CcdOffer.
Return type:	str

reporting_region¶

Gets the reporting_region of this CcdOffer. Defines where the filler usage is reported

Returns:	The reporting_region of this CcdOffer.
Return type:	str

sku¶

[Required] Gets the sku of this CcdOffer. The SKU part number (prefaced with “B”) the CCD is associated with.

Returns:	The sku of this CcdOffer.
Return type:	str

sku_display_name¶

[Required] Gets the sku_display_name of this CcdOffer. The canonical SKU display name.

Returns:	The sku_display_name of this CcdOffer.
Return type:	str

sku_metric¶

[Required] Gets the sku_metric of this CcdOffer. The canonical billing metric.

Returns:	The sku_metric of this CcdOffer.
Return type:	str

source_type¶

Gets the source_type of this CcdOffer. The commercial workflow that created the CCD offer/commitment. This value is immutable.

Allowed values for this property are: “CONTRACT_COMMITMENT”, “CONTRACT_OFFER”, “FLEX”, “OCI_GENERATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The source_type of this CcdOffer.
Return type:	str

subscription_id¶

Gets the subscription_id of this CcdOffer. The subscription OCID if a this is dedicated CCD offer for a customer.

Returns:	The subscription_id of this CcdOffer.
Return type:	str

system_tags¶

Gets the system_tags of this CcdOffer. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this CcdOffer.
Return type:	dict(str, dict(str, object))

term¶

[Required] Gets the term of this CcdOffer. The number of terms the offer is applicable to.

Returns:	The term of this CcdOffer.
Return type:	int

time_ccd_offer_ends¶

Gets the time_ccd_offer_ends of this CcdOffer. The inclusive time when the CCD offer is no longer in effect, and must be after timeCcdOfferStarts. The format is defined by RFC 3339.

Returns:	The time_ccd_offer_ends of this CcdOffer.
Return type:	datetime

time_ccd_offer_starts¶

Gets the time_ccd_offer_starts of this CcdOffer. The inclusive date the CCD offer will be effective. The format is defined by RFC 3339.

Returns:	The time_ccd_offer_starts of this CcdOffer.
Return type:	datetime

time_created¶

Gets the time_created of this CcdOffer. Date and time the CCD was created. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

Returns:	The time_created of this CcdOffer.
Return type:	datetime

time_terminated¶

Gets the time_terminated of this CcdOffer. Date and time the CCD was terminated. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

Returns:	The time_terminated of this CcdOffer.
Return type:	datetime

time_updated¶

Gets the time_updated of this CcdOffer. Date and time the CCD was updated lastly. The format is defined by RFC 3339. Example: 2025-01-25T21:10:29.600Z

Returns:	The time_updated of this CcdOffer.
Return type:	datetime

type_of_offer¶

Gets the type_of_offer of this CcdOffer. The CCD offer type.

Allowed values for this property are: “STANDARD”, “CUSTOM”, “PRIVATE”, “CONTRACTUAL”, “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type_of_offer of this CcdOffer.
Return type:	str

unit¶

Gets the unit of this CcdOffer. The term units.

Allowed values for this property are: “MONTHS”, “YEARS”, “DAYS”, “HOURS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The unit of this CcdOffer.
Return type:	str