SubscriptionSummary

class oci.tenant_manager_control_plane.models.SubscriptionSummary(**kwargs)

Bases: object

Summary of subscription.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
classic_subscription_id [Required] Gets the classic_subscription_id of this SubscriptionSummary.
compartment_id [Required] Gets the compartment_id of this SubscriptionSummary.
end_date Gets the end_date of this SubscriptionSummary.
id [Required] Gets the id of this SubscriptionSummary.
is_classic_subscription Gets the is_classic_subscription of this SubscriptionSummary.
lifecycle_state Gets the lifecycle_state of this SubscriptionSummary.
payment_model Gets the payment_model of this SubscriptionSummary.
region_assignment Gets the region_assignment of this SubscriptionSummary.
service_name [Required] Gets the service_name of this SubscriptionSummary.
start_date Gets the start_date of this SubscriptionSummary.
time_created Gets the time_created of this SubscriptionSummary.
time_updated Gets the time_updated of this SubscriptionSummary.

Methods

__init__(**kwargs) Initializes a new SubscriptionSummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new SubscriptionSummary 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 SubscriptionSummary.
  • classic_subscription_id (str) – The value to assign to the classic_subscription_id property of this SubscriptionSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this SubscriptionSummary.
  • service_name (str) – The value to assign to the service_name property of this SubscriptionSummary.
  • is_classic_subscription (bool) – The value to assign to the is_classic_subscription property of this SubscriptionSummary.
  • payment_model (str) – The value to assign to the payment_model property of this SubscriptionSummary.
  • region_assignment (str) – The value to assign to the region_assignment property of this SubscriptionSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SubscriptionSummary. 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’.
  • start_date (datetime) – The value to assign to the start_date property of this SubscriptionSummary.
  • end_date (datetime) – The value to assign to the end_date property of this SubscriptionSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this SubscriptionSummary.
  • time_created (datetime) – The value to assign to the time_created property of this SubscriptionSummary.
classic_subscription_id

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

Returns:The classic_subscription_id of this SubscriptionSummary.
Return type:str
compartment_id

[Required] Gets the compartment_id of this SubscriptionSummary. OCID of the compartment. Always a tenancy OCID.

Returns:The compartment_id of this SubscriptionSummary.
Return type:str
end_date

Gets the end_date of this SubscriptionSummary. Subscription end time.

Returns:The end_date of this SubscriptionSummary.
Return type:datetime
id

[Required] Gets the id of this SubscriptionSummary. OCID of the subscription details for a particular root compartment or tenancy.

Returns:The id of this SubscriptionSummary.
Return type:str
is_classic_subscription

Gets the is_classic_subscription of this SubscriptionSummary. Denotes if the subscription is from classic systems or not.

Returns:The is_classic_subscription of this SubscriptionSummary.
Return type:bool
lifecycle_state

Gets the lifecycle_state of this SubscriptionSummary. 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 SubscriptionSummary.
Return type:str
payment_model

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

Returns:The payment_model of this SubscriptionSummary.
Return type:str
region_assignment

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

Returns:The region_assignment of this SubscriptionSummary.
Return type:str
service_name

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

Returns:The service_name of this SubscriptionSummary.
Return type:str
start_date

Gets the start_date of this SubscriptionSummary. Subscription start time.

Returns:The start_date of this SubscriptionSummary.
Return type:datetime
time_created

Gets the time_created of this SubscriptionSummary. Date-time when subscription is created.

Returns:The time_created of this SubscriptionSummary.
Return type:datetime
time_updated

Gets the time_updated of this SubscriptionSummary. Date-time when subscription is updated.

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