Class CreateSubscriptionUsageRecordDetails

A single usage record to submit for a marketplace offer. The usage window must have timeUsageStarted before timeUsageEnded.

Inheritance

object

CreateSubscriptionUsageRecordDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.SelfService.Models

Assembly: OCI.DotNetSDK.Self.dll

Syntax

public class CreateSubscriptionUsageRecordDetails

Properties

AdditionalMetadata

Declaration

[JsonProperty(PropertyName = "additionalMetadata")]
public List<ExtendedMetadata> AdditionalMetadata { get; set; }

Property Value

Type	Description
List<ExtendedMetadata>	Additional key/value metadata associated with this usage record for extensibility.

Amount

Declaration

[Required(ErrorMessage = "Amount is required.")]
[JsonProperty(PropertyName = "amount")]
public double Amount { get; set; }

Property Value

Type	Description
double	The non-negative usage cost computed by the partner for the submitted usage quantity.

Remarks

Required

BillingIdentifier

Declaration

[JsonProperty(PropertyName = "billingIdentifier")]
public string BillingIdentifier { get; set; }

Property Value

Type	Description
string	The partner billing identifier associated with this usage record.

BillingPeriod

Declaration

[JsonProperty(PropertyName = "billingPeriod")]
public string BillingPeriod { get; set; }

Property Value

Type	Description
string	The billing period associated with this usage record in YYYY-MM format.

BillingType

Declaration

[JsonProperty(PropertyName = "billingType")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateSubscriptionUsageRecordDetails.BillingTypeEnum? BillingType { get; set; }

Property Value

Type	Description
CreateSubscriptionUsageRecordDetails.BillingTypeEnum?	The billing type this usage record applies to.

ConsumedQuantity

Declaration

[JsonProperty(PropertyName = "consumedQuantity")]
public double ConsumedQuantity { get; set; }

Property Value

Type	Description
double	An optional non-negative usage quantity being reported.

ContractDuration

Declaration

[JsonProperty(PropertyName = "contractDuration")]
[JsonConverter(typeof(StringEnumConverter))]
public BillingFrequency? ContractDuration { get; set; }

Property Value

Type	Description
BillingFrequency?	The contract duration associated with this usage record.

CurrencyCode

Declaration

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

Property Value

Type	Description
string	The ISO-4217 currency submitted for the computed usage cost.

Remarks

Required

CustomerTenancyId

Declaration

[JsonProperty(PropertyName = "customerTenancyId")]
public string CustomerTenancyId { get; set; }

Property Value

Type	Description
string	The OCID of the customer tenancy associated with this usage record.

Id

Declaration

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

Property Value

Type	Description
string	Partner-provided unique identifier for this usage record. This identifier must be unique per partner.

Remarks

Required

MarketplaceOfferId

Declaration

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

Property Value

Type	Description
string	The OCID of the marketplace offer being billed. A submit request can contain records for multiple marketplace offers.

Remarks

Required

ProductSku

Declaration

[JsonProperty(PropertyName = "productSku")]
public string ProductSku { get; set; }

Property Value

Type	Description
string	The product SKU associated with this usage record.

TimeUsageEnded

Declaration

[Required(ErrorMessage = "TimeUsageEnded is required.")]
[JsonProperty(PropertyName = "timeUsageEnded")]
public DateTime? TimeUsageEnded { get; set; }

Property Value

Type	Description
DateTime?	The exclusive end timestamp for the usage window. This value must be after timeUsageStarted.

Remarks

Required

TimeUsageStarted

Declaration

[Required(ErrorMessage = "TimeUsageStarted is required.")]
[JsonProperty(PropertyName = "timeUsageStarted")]
public DateTime? TimeUsageStarted { get; set; }

Property Value

Type	Description
DateTime?	The inclusive start timestamp for the usage window. This value must be before timeUsageEnded.

Remarks

Required

UnitOfMeasure

Declaration

[JsonProperty(PropertyName = "unitOfMeasure")]
public string UnitOfMeasure { get; set; }

Property Value

Type	Description
string	The unit of measure associated with the reported usage quantity.

UnitPrice

Declaration

[JsonProperty(PropertyName = "unitPrice")]
public double UnitPrice { get; set; }

Property Value

Type	Description
double	The unit price associated with this usage record.

UsageDimensionName

Declaration

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

Property Value

Type	Description
string	The pricing dimension against which usage is being reported.

Remarks

Required

UsageRecordId

Declaration

[JsonProperty(PropertyName = "usageRecordId")]
public string UsageRecordId { get; set; }

Property Value

Type	Description
string	Partner-provided usage record identifier for traceability.