UsageBasedPricingPlan¶
- class oci.marketplace_publisher.models.UsageBasedPricingPlan(**kwargs)¶
Bases:
PricingPlanUsage-based SaaS pricing plan where all billing is driven by dimensions.
Attributes:
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan.
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan.
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan.
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan.
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan.
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan.
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan.
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan.
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan.
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan.
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan.
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan.
A constant which can be used with the plan_type property of a PricingPlan.
A constant which can be used with the plan_type property of a PricingPlan.
A constant which can be used with the plan_type property of a PricingPlan.
A constant which can be used with the plan_type property of a PricingPlan.
[Required] Gets the billing_frequency of this UsageBasedPricingPlan.
[Required] Gets the dimensions of this UsageBasedPricingPlan.
Gets the extended_metadata of this UsageBasedPricingPlan.
[Required] Gets the name of this UsageBasedPricingPlan.
[Required] Gets the plan_description of this UsageBasedPricingPlan.
Gets the plan_duration of this UsageBasedPricingPlan.
[Required] Gets the plan_type of this PricingPlan.
Gets the pricing_plan_key of this UsageBasedPricingPlan.
[Required] Gets the rates of this PricingPlan.
Methods:
__init__(**kwargs)Initializes a new UsageBasedPricingPlan 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.
- BILLING_FREQUENCY_ANNUAL = 'ANNUAL'¶
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan. This constant has a value of “ANNUAL”
- BILLING_FREQUENCY_BIENNIAL = 'BIENNIAL'¶
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan. This constant has a value of “BIENNIAL”
- BILLING_FREQUENCY_MONTHLY = 'MONTHLY'¶
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan. This constant has a value of “MONTHLY”
- BILLING_FREQUENCY_QUARTERLY = 'QUARTERLY'¶
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan. This constant has a value of “QUARTERLY”
- BILLING_FREQUENCY_SEMI_ANNUAL = 'SEMI_ANNUAL'¶
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan. This constant has a value of “SEMI_ANNUAL”
- BILLING_FREQUENCY_TRIENNIAL = 'TRIENNIAL'¶
A constant which can be used with the billing_frequency property of a UsageBasedPricingPlan. This constant has a value of “TRIENNIAL”
- PLAN_DURATION_ANNUAL = 'ANNUAL'¶
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan. This constant has a value of “ANNUAL”
- PLAN_DURATION_BIENNIAL = 'BIENNIAL'¶
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan. This constant has a value of “BIENNIAL”
- PLAN_DURATION_MONTHLY = 'MONTHLY'¶
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan. This constant has a value of “MONTHLY”
- PLAN_DURATION_QUARTERLY = 'QUARTERLY'¶
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan. This constant has a value of “QUARTERLY”
- PLAN_DURATION_SEMI_ANNUAL = 'SEMI_ANNUAL'¶
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan. This constant has a value of “SEMI_ANNUAL”
- PLAN_DURATION_TRIENNIAL = 'TRIENNIAL'¶
A constant which can be used with the plan_duration property of a UsageBasedPricingPlan. This constant has a value of “TRIENNIAL”
- PLAN_TYPE_FIXED = 'FIXED'¶
A constant which can be used with the plan_type property of a PricingPlan. This constant has a value of “FIXED”
- PLAN_TYPE_HYBRID = 'HYBRID'¶
A constant which can be used with the plan_type property of a PricingPlan. This constant has a value of “HYBRID”
- PLAN_TYPE_METERED = 'METERED'¶
A constant which can be used with the plan_type property of a PricingPlan. This constant has a value of “METERED”
- PLAN_TYPE_USAGE_BASED = 'USAGE_BASED'¶
A constant which can be used with the plan_type property of a PricingPlan. This constant has a value of “USAGE_BASED”
- __init__(**kwargs)¶
Initializes a new UsageBasedPricingPlan object with values from keyword arguments. The default value of the
plan_typeattribute of this class isUSAGE_BASEDand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
plan_type (str) – The value to assign to the plan_type property of this UsageBasedPricingPlan. Allowed values for this property are: “METERED”, “FIXED”, “USAGE_BASED”, “HYBRID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
rates (list[oci.marketplace_publisher.models.PricingRate]) – The value to assign to the rates property of this UsageBasedPricingPlan.
pricing_plan_key (str) – The value to assign to the pricing_plan_key property of this UsageBasedPricingPlan.
name (str) – The value to assign to the name property of this UsageBasedPricingPlan.
plan_description (str) – The value to assign to the plan_description property of this UsageBasedPricingPlan.
billing_frequency (str) – The value to assign to the billing_frequency property of this UsageBasedPricingPlan. Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
plan_duration (str) – The value to assign to the plan_duration property of this UsageBasedPricingPlan. Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dimensions (list[oci.marketplace_publisher.models.UsageDimension]) – The value to assign to the dimensions property of this UsageBasedPricingPlan.
extended_metadata (dict(str, str)) – The value to assign to the extended_metadata property of this UsageBasedPricingPlan.
- property billing_frequency¶
[Required] Gets the billing_frequency of this UsageBasedPricingPlan. The plan billing frequency.
Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The billing_frequency of this UsageBasedPricingPlan.
- Return type
str
- property dimensions¶
[Required] Gets the dimensions of this UsageBasedPricingPlan. The usage dimensions that define billable usage for this plan.
- Returns
The dimensions of this UsageBasedPricingPlan.
- Return type
- property extended_metadata¶
Gets the extended_metadata of this UsageBasedPricingPlan. Additional metadata key/value pairs for the usage-based pricing.
- Returns
The extended_metadata of this UsageBasedPricingPlan.
- 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.
- property name¶
[Required] Gets the name of this UsageBasedPricingPlan. The plan name.
- Returns
The name of this UsageBasedPricingPlan.
- Return type
str
- property plan_description¶
[Required] Gets the plan_description of this UsageBasedPricingPlan. The plan description.
- Returns
The plan_description of this UsageBasedPricingPlan.
- Return type
str
- property plan_duration¶
Gets the plan_duration of this UsageBasedPricingPlan. The plan duration.
Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The plan_duration of this UsageBasedPricingPlan.
- Return type
str
- property plan_type¶
[Required] Gets the plan_type of this PricingPlan. The listing’s pricing plan type.
Allowed values for this property are: “METERED”, “FIXED”, “USAGE_BASED”, “HYBRID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The plan_type of this PricingPlan.
- Return type
str
- property pricing_plan_key¶
Gets the pricing_plan_key of this UsageBasedPricingPlan. Unique identifier of the pricing plan.
- Returns
The pricing_plan_key of this UsageBasedPricingPlan.
- Return type
str
- property rates¶
[Required] Gets the rates of this PricingPlan. List of pricing rates provider by publisher.
- Returns
The rates of this PricingPlan.
- Return type