ClassicSubscription¶

class oci.tenant_manager_control_plane.models.ClassicSubscription(**kwargs)¶

Bases: oci.tenant_manager_control_plane.models.subscription.Subscription

Subscription information for the compartmentId. Only root compartments are allowed.

Attributes

`ENTITY_VERSION_V1`	str(object=’’) -> str
`ENTITY_VERSION_V2`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ClassicSubscription.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ClassicSubscription.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ClassicSubscription.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ClassicSubscription.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ClassicSubscription.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ClassicSubscription.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ClassicSubscription.
`classic_subscription_id`	[Required] Gets the classic_subscription_id of this ClassicSubscription.
`cloud_amount_currency`	Gets the cloud_amount_currency of this ClassicSubscription.
`compartment_id`	[Required] Gets the compartment_id of this Subscription.
`csi_number`	Gets the csi_number of this ClassicSubscription.
`customer_country_code`	Gets the customer_country_code of this ClassicSubscription.
`defined_tags`	[Required] Gets the defined_tags of this Subscription.
`end_date`	Gets the end_date of this ClassicSubscription.
`entity_version`	[Required] Gets the entity_version of this Subscription.
`freeform_tags`	[Required] Gets the freeform_tags of this Subscription.
`id`	[Required] Gets the id of this Subscription.
`is_classic_subscription`	Gets the is_classic_subscription of this ClassicSubscription.
`is_government_subscription`	Gets the is_government_subscription of this ClassicSubscription.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ClassicSubscription.
`payment_model`	Gets the payment_model of this ClassicSubscription.
`program_type`	Gets the program_type of this ClassicSubscription.
`promotion`	Gets the promotion of this ClassicSubscription.
`purchase_entitlement_id`	Gets the purchase_entitlement_id of this ClassicSubscription.
`region_assignment`	Gets the region_assignment of this ClassicSubscription.
`service_name`	[Required] Gets the service_name of this Subscription.
`skus`	Gets the skus of this ClassicSubscription.
`start_date`	Gets the start_date of this ClassicSubscription.
`subscription_tier`	Gets the subscription_tier of this ClassicSubscription.
`time_created`	[Required] Gets the time_created of this Subscription.
`time_updated`	[Required] Gets the time_updated of this Subscription.

Methods

`__init__`(**kwargs)	Initializes a new ClassicSubscription object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ENTITY_VERSION_V1 = 'V1'¶

ENTITY_VERSION_V2 = 'V2'¶

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

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ClassicSubscription. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ClassicSubscription. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ClassicSubscription. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ClassicSubscription. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ClassicSubscription. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ClassicSubscription. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ClassicSubscription object with values from keyword arguments. The default value of the entity_version attribute of this class is V1 and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

entity_version (str) – The value to assign to the entity_version property of this ClassicSubscription. Allowed values for this property are: “V1”, “V2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this ClassicSubscription.
compartment_id (str) – The value to assign to the compartment_id property of this ClassicSubscription.
service_name (str) – The value to assign to the service_name property of this ClassicSubscription.
time_created (datetime) – The value to assign to the time_created property of this ClassicSubscription.
time_updated (datetime) – The value to assign to the time_updated property of this ClassicSubscription.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ClassicSubscription.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ClassicSubscription.
classic_subscription_id (str) – The value to assign to the classic_subscription_id property of this ClassicSubscription.
is_classic_subscription (bool) – The value to assign to the is_classic_subscription property of this ClassicSubscription.
payment_model (str) – The value to assign to the payment_model property of this ClassicSubscription.
region_assignment (str) – The value to assign to the region_assignment property of this ClassicSubscription.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ClassicSubscription. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
skus (list[oci.tenant_manager_control_plane.models.SubscriptionSku]) – The value to assign to the skus property of this ClassicSubscription.
program_type (str) – The value to assign to the program_type property of this ClassicSubscription.
customer_country_code (str) – The value to assign to the customer_country_code property of this ClassicSubscription.
cloud_amount_currency (str) – The value to assign to the cloud_amount_currency property of this ClassicSubscription.
csi_number (str) – The value to assign to the csi_number property of this ClassicSubscription.
subscription_tier (str) – The value to assign to the subscription_tier property of this ClassicSubscription.
is_government_subscription (bool) – The value to assign to the is_government_subscription property of this ClassicSubscription.
promotion (list[oci.tenant_manager_control_plane.models.Promotion]) – The value to assign to the promotion property of this ClassicSubscription.
purchase_entitlement_id (str) – The value to assign to the purchase_entitlement_id property of this ClassicSubscription.
start_date (datetime) – The value to assign to the start_date property of this ClassicSubscription.
end_date (datetime) – The value to assign to the end_date property of this ClassicSubscription.

classic_subscription_id¶

[Required] Gets the classic_subscription_id of this ClassicSubscription. Classic subscription ID.

Returns:	The classic_subscription_id of this ClassicSubscription.
Return type:	str

cloud_amount_currency¶

Gets the cloud_amount_currency of this ClassicSubscription. The currency code for the customer associated with the subscription.

Returns:	The cloud_amount_currency of this ClassicSubscription.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this Subscription. The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.

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

csi_number¶

Gets the csi_number of this ClassicSubscription. Customer service identifier for the customer associated with the subscription.

Returns:	The csi_number of this ClassicSubscription.
Return type:	str

customer_country_code¶

Gets the customer_country_code of this ClassicSubscription. The country code for the customer associated with the subscription.

Returns:	The customer_country_code of this ClassicSubscription.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this Subscription. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

end_date¶

Gets the end_date of this ClassicSubscription. Subscription end time.

Returns:	The end_date of this ClassicSubscription.
Return type:	datetime

entity_version¶

[Required] Gets the entity_version of this Subscription. The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).

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

Returns:	The entity_version of this Subscription.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this Subscription. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

[Required] Gets the id of this Subscription. The Oracle ID (OCID) of the subscription.

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

is_classic_subscription¶

Gets the is_classic_subscription of this ClassicSubscription. Specifies whether or not the subscription is from classic systems.

Returns:	The is_classic_subscription of this ClassicSubscription.
Return type:	bool

is_government_subscription¶

Gets the is_government_subscription of this ClassicSubscription. Specifies whether or not the subscription is a government subscription.

Returns:	The is_government_subscription of this ClassicSubscription.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this ClassicSubscription. Lifecycle state of the subscription.

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

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

payment_model¶

Gets the payment_model of this ClassicSubscription. The pay model of the subscription, such as ‘Pay as you go’ or ‘Monthly’.

Returns:	The payment_model of this ClassicSubscription.
Return type:	str

program_type¶

Gets the program_type of this ClassicSubscription. Specifies any program that is associated with the subscription.

Returns:	The program_type of this ClassicSubscription.
Return type:	str

promotion¶

Gets the promotion of this ClassicSubscription. List of promotions related to the subscription.

Returns:	The promotion of this ClassicSubscription.
Return type:	list[oci.tenant_manager_control_plane.models.Promotion]

purchase_entitlement_id¶

Gets the purchase_entitlement_id of this ClassicSubscription. Purchase entitlement ID associated with the subscription.

Returns:	The purchase_entitlement_id of this ClassicSubscription.
Return type:	str

region_assignment¶

Gets the region_assignment of this ClassicSubscription. Region for the subscription.

Returns:	The region_assignment of this ClassicSubscription.
Return type:	str

service_name¶

[Required] Gets the service_name of this Subscription. The type of subscription, such as ‘UCM’, ‘SAAS’, ‘ERP’, ‘CRM’.

Returns:	The service_name of this Subscription.
Return type:	str

skus¶

Gets the skus of this ClassicSubscription. List of SKUs linked to this subscription.

Returns:	The skus of this ClassicSubscription.
Return type:	list[oci.tenant_manager_control_plane.models.SubscriptionSku]

start_date¶

Gets the start_date of this ClassicSubscription. Subscription start time.

Returns:	The start_date of this ClassicSubscription.
Return type:	datetime

subscription_tier¶

Gets the subscription_tier of this ClassicSubscription. Tier for the subscription, whether a free promotion subscription or a paid subscription.

Returns:	The subscription_tier of this ClassicSubscription.
Return type:	str

time_created¶

[Required] Gets the time_created of this Subscription. The date and time of creation, as described in RFC 3339, section 14.29.

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

time_updated¶

[Required] Gets the time_updated of this Subscription. The date and time of update, as described in RFC 3339, section 14.29.

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