Class Subscription
The model for a listing subscription.
Inherited Members
Namespace: Oci.SelfService.Models
Assembly: OCI.DotNetSDK.Self.dll
Syntax
public class Subscription
Properties
AdditionalDetails
Declaration
[JsonProperty(PropertyName = "additionalDetails")]
public List<ExtendedMetadata> AdditionalDetails { get; set; }
Property Value
| Type | Description |
|---|---|
| List<ExtendedMetadata> | Additional details that are specific for this subscription such as activation details. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The unique identifier for the compartment where the subscription was purchased. |
Remarks
Required
DefinedTags
Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[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.
|
Remarks
Required
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The subscription name. Must be unique within the compartment. This value can be updated. |
Remarks
Required
FreeformTags
Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[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.
|
Remarks
Required
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The unique identifier for the subscription within a specific compartment. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleDetailsEnum? LifecycleDetails { get; set; }
Property Value
| Type | Description |
|---|---|
| LifecycleDetailsEnum? | A message that describes the current state of the Subscription in more detail. For example, can be used to provide actionable information for a resource in the Failed state. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleStateEnum? LifecycleState { get; set; }
Property Value
| Type | Description |
|---|---|
| LifecycleStateEnum? | The current lifecycle state of the Subscription. |
Remarks
Required
ProductId
Declaration
[JsonProperty(PropertyName = "productId")]
public string ProductId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The unique OCID of the product, effectively functioning as the listing ID. |
Realm
Declaration
[JsonProperty(PropertyName = "realm")]
public string Realm { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The realm from where customer is buying the subscription. |
Region
Declaration
[JsonProperty(PropertyName = "region")]
public string Region { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The region from where customer is buying the subscription. |
SellerId
Declaration
[JsonProperty(PropertyName = "sellerId")]
public string SellerId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The OCID that identifies the seller within the platform. |
SourceType
Declaration
[JsonProperty(PropertyName = "sourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SourceType? SourceType { get; set; }
Property Value
| Type | Description |
|---|---|
| SourceType? | The type of seller in SELF Service. |
SubscriptionDetails
Declaration
[JsonProperty(PropertyName = "subscriptionDetails")]
public SubscriptionDetails SubscriptionDetails { get; set; }
Property Value
| Type | Description |
|---|---|
| SubscriptionDetails |
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.
|
TenantId
Declaration
[Required(ErrorMessage = "TenantId is required.")]
[JsonProperty(PropertyName = "tenantId")]
public string TenantId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The unique identifier for the tenant where the subscription was purchased. |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time the Subscription was created, in the format defined by RFC 3339.
|
Remarks
Required
TimeEnded
Declaration
[JsonProperty(PropertyName = "timeEnded")]
public DateTime? TimeEnded { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time the Subscription was ended, in the format defined by RFC 3339.
|
TimeStarted
Declaration
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time the Subscription was started, in the format defined by RFC 3339.
|
TimeUpdated
Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time the Subscription was updated, in the format defined by RFC 3339.
|