# ProductRatePlanChargeRest


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**class__ns** | **str** | Class associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**deferred_rev_account__ns** | **str** | Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**department__ns** | **str** | Department associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**include_children__ns** | [**ProductRatePlanChargeObjectNSFieldsIncludeChildrenNS**](ProductRatePlanChargeObjectNSFieldsIncludeChildrenNS.md) |  | [optional] 
**integration_id__ns** | **str** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**integration_status__ns** | **str** | Status of the product rate plan charge&#39;s synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**item_type__ns** | [**ProductRatePlanChargeObjectNSFieldsItemTypeNS**](ProductRatePlanChargeObjectNSFieldsItemTypeNS.md) |  | [optional] 
**location__ns** | **str** | Location associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**recognized_rev_account__ns** | **str** | Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**rev_rec_end__ns** | [**ProductRatePlanChargeObjectNSFieldsRevRecEndNS**](ProductRatePlanChargeObjectNSFieldsRevRecEndNS.md) |  | [optional] 
**rev_rec_start__ns** | [**ProductRatePlanChargeObjectNSFieldsRevRecStartNS**](ProductRatePlanChargeObjectNSFieldsRevRecStartNS.md) |  | [optional] 
**rev_rec_template_type__ns** | **str** | Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**subsidiary__ns** | **str** | Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**sync_date__ns** | **str** | Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;265).  | [optional] 
**id** | **str** | Unique product rate-plan charge ID.  | [optional] 
**name** | **str** | Name of the product rate-plan charge. (Not required to be unique.)  | [optional] 
**type** | **str** | The type of charge. Possible values are: &#x60;OneTime&#x60;, &#x60;Recurring&#x60;, &#x60;Usage&#x60;. | [optional] 
**model** | **str** | Charge model which determines how charges are calculated. Charge models must be individually activated in Zuora Billing administration.  Possible values are: - &#x60;FlatFee&#x60; - &#x60;PerUnit&#x60; - &#x60;Overage&#x60; - &#x60;Volume&#x60; - &#x60;Tiered&#x60; - &#x60;TieredWithOverage&#x60; - &#x60;DiscountFixedAmount&#x60; - &#x60;DiscountPercentage&#x60; - &#x60;Delivery&#x60; - &#x60;MultiAttributePricing&#x60; - &#x60;PreratedPerUnit&#x60; - &#x60;PreratedPricing&#x60; - &#x60;HighWatermarkVolumePricing&#x60; - &#x60;HighWatermarkTieredPricing&#x60; | [optional] 
**description** | **str** | Usually a brief line item summary of the Rate Plan Charge.  | [optional] 
**product_rate_plan_charge_number** | **str** | The natural key of the product rate plan charge.  | [optional] 
**apply_to_billing_period_partially** | **bool** | Whether to apply the charge partially based on the billing period.  | [optional] 
**apply_discount_to** | **str** | Specifies where (to what charge type) the discount will be applied. These field values are case-sensitive.  Permissible values: - RECURRING - USAGE - ONETIMERECURRING - ONETIMEUSAGE - RECURRINGUSAGE - ONETIMERECURRINGUSAGE | [optional] 
**billing_day** | **str** | The bill cycle day (BCD) for the charge. The BCD determines which day of the month or week the customer is billed. The BCD value in the account can override the BCD in this object. | [optional] 
**billing_period** | **str** | The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).  Values: - Month - Quarter - Annual - Semi-Annual - Specific Months - Week - Specific_Weeks | [optional] 
**billing_period_alignment** | **str** | Aligns charges within the same subscription if multiple charges begin on different dates.  Possible values: - AlignToCharge - AlignToSubscriptionStart - AlignToTermStart | [optional] 
**billing_timing** | **str** | The billing timing for the charge. You can choose to bill for charges in advance or in arrears.  Values: - IN_ADVANCE - IN_ARREARS | [optional] 
**charge_function** | **str** | The function of the charge.  | [optional] 
**charge_model_configurations** | **object** | This field is for Zuora Internal Use only. See the **pricing** field for the same information as this field. | [optional] 
**commitment_type** | **str** | The commitment type of the charge.  | [optional] 
**credit_option** | **str** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The way to calculate credit. | [optional] 
**default_quantity** | **decimal.Decimal** | The default quantity of units. This field is required if you use a per-unit charge model. | [optional] 
**delivery_schedule** | [**GetProductRatePlanChargeDeliverySchedule**](GetProductRatePlanChargeDeliverySchedule.md) |  | [optional] 
**discount_class** | **str** | The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied. | [optional] 
**discount_level** | **str** | The level of the discount.  Values: - RatePlan - Subscription - Account | [optional] 
**drawdown_rate** | **float** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (&gt;0). | [optional] 
**drawdown_uom** | **str** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  Unit of measurement for a drawdown charge. | [optional] 
**eligible_account_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which accounts are eligible for this calculated charge. Only applicable when charge model is &#x60;Calculated&#x60;. | [optional] 
**eligible_charge_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which charges are eligible to be calculated by this charge. Only applicable when charge model is &#x60;Calculated&#x60;. | [optional] 
**end_date_condition** | **str** | Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.  Values: - Subscription_End - Fixed_Period | [optional] 
**exclude_item_billing_from_revenue_accounting** | **bool** | The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.  **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. | [optional] 
**exclude_item_booking_from_revenue_accounting** | **bool** | The flag to exclude the related rate plan charges and order line items from revenue accounting.  **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. | [optional] 
**finance_information** | [**FinanceInformation**](FinanceInformation.md) |  | [optional] 
**formula** | **str** | The pricing formula to calculate the actual rating amount for each usage record.  This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. | [optional] 
**included_units** | **decimal.Decimal** | Specifies the number of units in the base set of units when the charge model is Overage. | [optional] 
**is_allocation_eligible** | **bool** | This field is used to identify if the charge segment is allocation eligible in revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. | [optional] 
**is_prepaid** | **bool** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. | [optional] 
**is_rollover** | **bool** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  Determines whether the rollover fields are needed. | [optional] 
**is_stacked_discount** | **bool** | **Note**: This field is only applicable to the Discount - Percentage charge model.  This field indicates whether the discount is to be calculated as stacked discount.  - &#x60;true&#x60;: This is a stacked discount, which should be calculated by stacking with other discounts. - &#x60;false&#x60;: This is not a stacked discount, which should be calculated in sequence with other discounts. | [optional] 
**is_unbilled** | **bool** | This field is used to dictate how to perform the accounting during revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. | [optional] 
**list_price_base** | **str** | The list price base for the product rate plan charge. This field is only applicable for recurring charges. | [optional] 
**max_quantity** | **decimal.Decimal** | Specifies the maximum number of units for this charge. Use this field and the &#x60;minQuantity&#x60; field to create a range of units allowed in a product rate plan charge. | [optional] 
**min_quantity** | **decimal.Decimal** | Specifies the minimum number of units for this charge. Use this field and the &#x60;maxQuantity&#x60; field to create a range of units allowed in a product rate plan charge. | [optional] 
**number_of_periods** | **int** | Value specifies the number of periods used in the smoothing model calculations. Used when overage smoothing model is &#x60;RollingWindow&#x60; or &#x60;Rollover&#x60;. | [optional] 
**overage_calculation_option** | **str** | Value specifies when to calculate overage charges.  Values: - EndOfSmoothingPeriod - PerBillingPeriod | [optional] 
**overage_unused_units_credit_option** | **str** | Determines whether to credit the customer with unused units of usage.  Values: - NoCredit - CreditBySpecificRate | [optional] 
**prepaid_operation_type** | **str** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. | [optional] 
**prepaid_quantity** | **float** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The number of units included in a prepayment charge. Must be a positive number (&gt;0). | [optional] 
**prepaid_total_quantity** | **float** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge. | [optional] 
**prepaid_uom** | **str** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  Unit of measurement for a prepayment charge. | [optional] 
**prepay_periods** | **int** | The number of periods to which prepayment is set.  **Note:** This field is only available if you already have the prepayment feature enabled. The prepayment feature is deprecated and available only for backward compatibility. | [optional] 
**proration_option** | **str** | Determines the prorating option for the charge.  | [optional] 
**price_change_option** | **str** | Applies an automatic price change when a termed subscription is renewed.  Values: - NoChange (default) - SpecificPercentageValue - UseLatestProductCatalogPricing | [optional] 
**price_increase_percentage** | **decimal.Decimal** | Specifies the percentage to increase or decrease the price of a termed subscription&#39;s renewal. Use this field if you set the &#x60;priceChangeOption&#x60; value to &#x60;SpecificPercentageValue&#x60;.  Values: a decimal between -100 and 100. | [optional] 
**pricing** | [**List[GetProductRatePlanChargePricingType]**](GetProductRatePlanChargePricingType.md) | One or more price charge models with attributes that further describe the model. Some attributes show as null values when not applicable. | [optional] 
**pricing_summary** | **List[str]** | A concise description of the charge model and pricing that is suitable to show to your customers. | [optional] 
**product_discount_apply_details** | [**List[GetProductDiscountApplyDetailsType]**](GetProductDiscountApplyDetailsType.md) | Container for the application details about a discount product rate plan charge. Only discount product rate plan charges have values in this field. | [optional] 
**rating_group** | **str** | Specifies a rating group based on which usage records are rated.  Possible values: - &#x60;ByBillingPeriod&#x60; (default) - &#x60;ByUsageStartDate&#x60; - &#x60;ByUsageRecord&#x60; - &#x60;ByUsageUpload&#x60; - &#x60;ByGroupId&#x60;  **Note**: Use this field only for Usage charges. One-Time Charges and Recurring Charges return &#x60;NULL&#x60;. | [optional] 
**rating_groups_operator_type** | **str** | The operator type for rating groups.  | [optional] 
**reflect_discount_in_net_amount** | **bool** | Whether to reflect the discount in the net amount.  | [optional] 
**rev_rec_code** | **str** | Associates this product rate plan charge with a specific revenue recognition code. | [optional] 
**rev_rec_trigger_condition** | **str** | Specifies when revenue recognition begins.  | [optional] 
**revenue_recognition_rule_name** | **str** | Specifies the revenue recognition rule.  | [optional] 
**revenue_recognition_timing** | **str** | This field is used to dictate the type of revenue recognition timing.  | [optional] 
**revenue_amortization_method** | **str** | This field is used to dictate the type of revenue amortization method.  | [optional] 
**rollover_apply** | **str** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  This field defines the priority of rollover, which is either first or last. | [optional] 
**rollover_periods** | **float** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  This field defines the number of rollover periods, it is restricted to 3. | [optional] 
**smoothing_model** | **str** | Specifies the smoothing model for an overage smoothing charge model or a tiered with overage model.  Values: - &#x60;RollingWindow&#x60; - &#x60;Rollover&#x60; | [optional] 
**specific_billing_period** | **int** | When the billing period is set to &#x60;Specific&#x60; Months then this positive integer reflects the number of months for billing period charges. | [optional] 
**specific_list_price_base** | **object** | The number of months for the list price base of the charge. The value of this field is &#x60;null&#x60; if you do not set the value of the &#x60;listPriceBase&#x60; field to &#x60;Per_Specific_Months&#x60;. | [optional] 
**tax_code** | **str** | Specifies the tax code for taxation rules; used by Zuora Tax.  | [optional] 
**tax_mode** | **str** | Specifies how to define taxation for the charge; used by Zuora Tax. Possible values are: &#x60;TaxExclusive&#x60;, &#x60;TaxInclusive&#x60;. | [optional] 
**taxable** | **bool** | Specifies whether the charge is taxable; used by Zuora Tax. Possible values are: &#x60;true&#x60;, &#x60;false&#x60;. | [optional] 
**trigger_event** | **str** | Specifies when to start billing the customer for the charge.  Values: - &#x60;ContractEffective&#x60; - &#x60;ServiceActivation&#x60; - &#x60;CustomerAcceptance&#x60; - &#x60;SpecificDate&#x60; | [optional] 
**uom** | **str** | Describes the Units of Measure (uom) configured in **Settings &gt; Billing** for the productRatePlanCharges. | [optional] 
**unused_included_unit_price** | **float** | The price for unused included units.  | [optional] 
**up_to_periods** | **int** | Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. | [optional] 
**up_to_periods_type** | **str** | The period type used to define when the charge ends.  Values: - Billing_Periods - Days - Weeks - Months - Years | [optional] 
**usage_record_rating_option** | **str** | Determines how Zuora processes usage records for per-unit usage charges.  | [optional] 
**use_discount_specific_accounting_code** | **bool** | Determines whether to define a new accounting code for the new discount charge. | [optional] 
**use_tenant_default_for_price_change** | **bool** | Shows the tenant-level percentage uplift value for an automatic price change to a termed subscription&#39;s renewal. | [optional] 
**validity_period_type** | **str** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The period in which the prepayment units are valid to use as defined in a prepayment charge. | [optional] 

## Example

```python
from zuora_sdk.models.product_rate_plan_charge_rest import ProductRatePlanChargeRest

# TODO update the JSON string below
json = "{}"
# create an instance of ProductRatePlanChargeRest from a JSON string
product_rate_plan_charge_rest_instance = ProductRatePlanChargeRest.from_json(json)
# print the JSON string representation of the object
print(ProductRatePlanChargeRest.to_json())

# convert the object into a dict
product_rate_plan_charge_rest_dict = product_rate_plan_charge_rest_instance.to_dict()
# create an instance of ProductRatePlanChargeRest from a dict
product_rate_plan_charge_rest_from_dict = ProductRatePlanChargeRest.from_dict(product_rate_plan_charge_rest_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


