CreateSubscriptionUsageRecordDetails¶
- class oci.self.models.CreateSubscriptionUsageRecordDetails(**kwargs)¶
Bases:
objectA single usage record to submit for a marketplace offer. The usage window must have timeUsageStarted before timeUsageEnded.
Attributes:
A constant which can be used with the billing_type property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the billing_type property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails.
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails.
Gets the additional_metadata of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the amount of this CreateSubscriptionUsageRecordDetails.
Gets the billing_identifier of this CreateSubscriptionUsageRecordDetails.
Gets the billing_period of this CreateSubscriptionUsageRecordDetails.
Gets the billing_type of this CreateSubscriptionUsageRecordDetails.
Gets the consumed_quantity of this CreateSubscriptionUsageRecordDetails.
Gets the contract_duration of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the currency_code of this CreateSubscriptionUsageRecordDetails.
Gets the customer_tenancy_id of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the id of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the listing_id of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the marketplace_offer_id of this CreateSubscriptionUsageRecordDetails.
Gets the product_sku of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the time_usage_ended of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the time_usage_started of this CreateSubscriptionUsageRecordDetails.
Gets the unit_of_measure of this CreateSubscriptionUsageRecordDetails.
Gets the unit_price of this CreateSubscriptionUsageRecordDetails.
[Required] Gets the usage_dimension_name of this CreateSubscriptionUsageRecordDetails.
Methods:
__init__(**kwargs)Initializes a new CreateSubscriptionUsageRecordDetails object with values from keyword arguments.
- BILLING_TYPE_FLAT_RATE = 'FLAT_RATE'¶
A constant which can be used with the billing_type property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “FLAT_RATE”
- BILLING_TYPE_USAGE_BASED = 'USAGE_BASED'¶
A constant which can be used with the billing_type property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “USAGE_BASED”
- CONTRACT_DURATION_ANNUAL = 'ANNUAL'¶
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “ANNUAL”
- CONTRACT_DURATION_BIENNIAL = 'BIENNIAL'¶
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “BIENNIAL”
- CONTRACT_DURATION_MONTHLY = 'MONTHLY'¶
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “MONTHLY”
- CONTRACT_DURATION_QUARTERLY = 'QUARTERLY'¶
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “QUARTERLY”
- CONTRACT_DURATION_SEMI_ANNUAL = 'SEMI_ANNUAL'¶
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “SEMI_ANNUAL”
- CONTRACT_DURATION_TRIENNIAL = 'TRIENNIAL'¶
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “TRIENNIAL”
- CONTRACT_DURATION_YEARLY = 'YEARLY'¶
A constant which can be used with the contract_duration property of a CreateSubscriptionUsageRecordDetails. This constant has a value of “YEARLY”
- __init__(**kwargs)¶
Initializes a new CreateSubscriptionUsageRecordDetails 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 CreateSubscriptionUsageRecordDetails.
marketplace_offer_id (str) – The value to assign to the marketplace_offer_id property of this CreateSubscriptionUsageRecordDetails.
listing_id (str) – The value to assign to the listing_id property of this CreateSubscriptionUsageRecordDetails.
billing_type (str) – The value to assign to the billing_type property of this CreateSubscriptionUsageRecordDetails. Allowed values for this property are: “FLAT_RATE”, “USAGE_BASED”
usage_dimension_name (str) – The value to assign to the usage_dimension_name property of this CreateSubscriptionUsageRecordDetails.
consumed_quantity (float) – The value to assign to the consumed_quantity property of this CreateSubscriptionUsageRecordDetails.
amount (float) – The value to assign to the amount property of this CreateSubscriptionUsageRecordDetails.
currency_code (str) – The value to assign to the currency_code property of this CreateSubscriptionUsageRecordDetails.
billing_period (str) – The value to assign to the billing_period property of this CreateSubscriptionUsageRecordDetails.
customer_tenancy_id (str) – The value to assign to the customer_tenancy_id property of this CreateSubscriptionUsageRecordDetails.
billing_identifier (str) – The value to assign to the billing_identifier property of this CreateSubscriptionUsageRecordDetails.
unit_of_measure (str) – The value to assign to the unit_of_measure property of this CreateSubscriptionUsageRecordDetails.
unit_price (float) – The value to assign to the unit_price property of this CreateSubscriptionUsageRecordDetails.
product_sku (str) – The value to assign to the product_sku property of this CreateSubscriptionUsageRecordDetails.
contract_duration (str) – The value to assign to the contract_duration property of this CreateSubscriptionUsageRecordDetails. Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, “YEARLY”
additional_metadata (list[oci.self.models.ExtendedMetadata]) – The value to assign to the additional_metadata property of this CreateSubscriptionUsageRecordDetails.
time_usage_started (datetime) – The value to assign to the time_usage_started property of this CreateSubscriptionUsageRecordDetails.
time_usage_ended (datetime) – The value to assign to the time_usage_ended property of this CreateSubscriptionUsageRecordDetails.
- property additional_metadata¶
Gets the additional_metadata of this CreateSubscriptionUsageRecordDetails. Additional key/value metadata associated with this usage record for extensibility.
- Returns
The additional_metadata of this CreateSubscriptionUsageRecordDetails.
- Return type
- property amount¶
[Required] Gets the amount of this CreateSubscriptionUsageRecordDetails. The non-negative usage cost computed by the partner for the submitted usage quantity.
- Returns
The amount of this CreateSubscriptionUsageRecordDetails.
- Return type
float
- property billing_identifier¶
Gets the billing_identifier of this CreateSubscriptionUsageRecordDetails. The partner billing identifier associated with this usage record.
- Returns
The billing_identifier of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property billing_period¶
Gets the billing_period of this CreateSubscriptionUsageRecordDetails. The billing period associated with this usage record in YYYY-MM format.
- Returns
The billing_period of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property billing_type¶
Gets the billing_type of this CreateSubscriptionUsageRecordDetails. The billing type this usage record applies to.
Allowed values for this property are: “FLAT_RATE”, “USAGE_BASED”
- Returns
The billing_type of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property consumed_quantity¶
Gets the consumed_quantity of this CreateSubscriptionUsageRecordDetails. An optional non-negative usage quantity being reported.
- Returns
The consumed_quantity of this CreateSubscriptionUsageRecordDetails.
- Return type
float
- property contract_duration¶
Gets the contract_duration of this CreateSubscriptionUsageRecordDetails. The contract duration associated with this usage record.
Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, “YEARLY”
- Returns
The contract_duration of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property currency_code¶
[Required] Gets the currency_code of this CreateSubscriptionUsageRecordDetails. The ISO-4217 currency submitted for the computed usage cost.
- Returns
The currency_code of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property customer_tenancy_id¶
Gets the customer_tenancy_id of this CreateSubscriptionUsageRecordDetails. The OCID of the customer tenancy associated with this usage record.
- Returns
The customer_tenancy_id of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property id¶
[Required] Gets the id of this CreateSubscriptionUsageRecordDetails. Partner-provided unique identifier for this usage record. This identifier must be unique per partner.
- Returns
The id of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property listing_id¶
[Required] Gets the listing_id of this CreateSubscriptionUsageRecordDetails. The OCID of the listing that generated this usage.
- Returns
The listing_id of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property marketplace_offer_id¶
[Required] Gets the marketplace_offer_id of this CreateSubscriptionUsageRecordDetails. The OCID of the marketplace offer being billed. A submit request can contain records for multiple marketplace offers.
- Returns
The marketplace_offer_id of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property product_sku¶
Gets the product_sku of this CreateSubscriptionUsageRecordDetails. The product SKU associated with this usage record.
- Returns
The product_sku of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property time_usage_ended¶
[Required] Gets the time_usage_ended of this CreateSubscriptionUsageRecordDetails. The exclusive end timestamp for the usage window. This value must be after timeUsageStarted.
- Returns
The time_usage_ended of this CreateSubscriptionUsageRecordDetails.
- Return type
datetime
- property time_usage_started¶
[Required] Gets the time_usage_started of this CreateSubscriptionUsageRecordDetails. The inclusive start timestamp for the usage window. This value must be before timeUsageEnded.
- Returns
The time_usage_started of this CreateSubscriptionUsageRecordDetails.
- Return type
datetime
- property unit_of_measure¶
Gets the unit_of_measure of this CreateSubscriptionUsageRecordDetails. The unit of measure associated with the reported usage quantity.
- Returns
The unit_of_measure of this CreateSubscriptionUsageRecordDetails.
- Return type
str
- property unit_price¶
Gets the unit_price of this CreateSubscriptionUsageRecordDetails. The unit price associated with this usage record.
- Returns
The unit_price of this CreateSubscriptionUsageRecordDetails.
- Return type
float
- property usage_dimension_name¶
[Required] Gets the usage_dimension_name of this CreateSubscriptionUsageRecordDetails. The pricing dimension against which usage is being reported.
- Returns
The usage_dimension_name of this CreateSubscriptionUsageRecordDetails.
- Return type
str