| apply_discount_to |
String |
Specifies the type of charges a specific discount applies to. This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is null. Possible values: * `RECURRING` * `USAGE` * `ONETIMERECURRING` * `ONETIMEUSAGE` * `RECURRINGUSAGE` * `ONETIMERECURRINGUSAGE` |
[optional] |
| billing_day |
String |
Billing cycle day (BCD), which is when bill runs generate invoices for charges associated with the product rate plan charge or the account. Values: * `DefaultFromCustomer` * `SpecificDayofMonth(#)` * `SubscriptionStartDay` * `ChargeTriggerDay` * `SpecificDayOfWeek/dayofweek`: in which dayofweek is the day in the week you define your billing periods to start. In the response data, a day-of-the-month value (`1`-`31`) appears in place of the hash sign above ("#"). If this value exceeds the number of days in a particular month, the last day of the month is used as the BCD. |
[optional] |
| billing_period |
String |
Allows billing period to be overridden on the rate plan charge. |
[optional] |
| billing_period_alignment |
String |
Possible values: * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart` |
[optional] |
| billing_timing |
String |
The billing timing for the charge. This field is only used if the `ratePlanChargeType` value is `Recurring`. Possible values are: * `In Advance` * `In Arrears` Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. |
[optional] |
| charged_through_date |
Date |
The date through which a customer has been billed for the charge. |
[optional] |
| currency |
String |
Currency used by the account. For example, `USD` or `EUR`. |
[optional] |
| custom_field__c |
String |
Any custom fields defined for this object. The custom field name is case-sensitive. |
[optional] |
| description |
String |
Description of the rate plan charge. |
[optional] |
| discount_amount |
String |
The amount of the discount. |
[optional] |
| discount_apply_details |
Array<GETDiscountApplyDetailsType> |
Container for the application details about a discount rate plan charge. Only discount rate plan charges have values in this field. |
[optional] |
| discount_class |
String |
The class that the discount belongs to. The discount class defines the order in which discount rate plan charges are applied. For more information, see Manage Discount Classes. |
[optional] |
| discount_level |
String |
The level of the discount. Values: `RatePlan`, `Subscription`, `Account`. |
[optional] |
| discount_percentage |
String |
The amount of the discount as a percentage. |
[optional] |
| dmrc |
String |
The change (delta) of monthly recurring charge exists when the change in monthly recurring revenue caused by an amendment or a new subscription. |
[optional] |
| done |
BOOLEAN |
A value of `true` indicates that an invoice for a charge segment has been completed. A value of `false` indicates that an invoice has not bee completed for the charge segment. |
[optional] |
| dtcv |
String |
After an amendment or an AutomatedPriceChange event, `dtcv` displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types. |
[optional] |
| effective_end_date |
Date |
The effective end date of the rate plan charge. |
[optional] |
| effective_start_date |
Date |
The effective start date of the rate plan charge. |
[optional] |
| end_date_condition |
String |
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` * `Specific_End_Date` |
[optional] |
| id |
String |
Rate plan charge ID. |
[optional] |
| included_units |
String |
Specifies the number of units in the base set of units. |
[optional] |
| list_price_base |
String |
List price base; possible values are: * `Per_Billing_Period` * `Per_Month` * `Per_Week` |
[optional] |
| model |
String |
Charge model; possible values are: * `FlatFee` * `PerUnit` * `Overage` * `Volume` * `Tiered` * `TieredWithOverage` * `DiscountFixedAmount` * `DiscountPercentage` |
[optional] |
| mrr |
String |
Monthly recurring revenue of the rate plan charge. |
[optional] |
| name |
String |
Charge name. |
[optional] |
| number |
String |
Charge number. |
[optional] |
| number_of_periods |
Integer |
Specifies the number of periods to use when calculating charges in an overage smoothing charge model. |
[optional] |
| original_charge_id |
String |
The original ID of the rate plan charge. |
[optional] |
| overage_calculation_option |
String |
Determines when to calculate overage charges. |
[optional] |
| overage_price |
String |
The price for units over the allowed amount. |
[optional] |
| overage_unused_units_credit_option |
String |
Determines whether to credit the customer with unused units of usage. |
[optional] |
| price |
String |
The price associated with the rate plan charge expressed as a decimal. |
[optional] |
| price_change_option |
String |
When the following is true: 1. AutomatedPriceChange setting is on 2. Charge type is not one-time 3. Charge model is not discount percentage Then an automatic price change can have a value for when a termed subscription is renewed. Values (one of the following): * `NoChange` (default) * `SpecificPercentageValue` * `UseLatestProductCatalogPricing` |
[optional] |
| price_increase_percentage |
String |
A planned future price increase amount as a percentage. |
[optional] |
| pricing_summary |
String |
Concise description of rate plan charge model. |
[optional] |
| processed_through_date |
Date |
The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended. |
[optional] |
| product_rate_plan_charge_id |
String |
|
[optional] |
| quantity |
String |
The quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing. |
[optional] |
| rating_group |
String |
Specifies a rating group based on which usage records are rated. Possible values are: * `ByBillingPeriod` (default) * `ByUsageStartDate` * `ByUsageRecord` * `ByUsageUpload` Note: This field is only used for per unit, volume pricing, and tiered pricing charge models. Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`. Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. |
[optional] |
| segment |
Integer |
The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1. |
[optional] |
| smoothing_model |
String |
Specifies when revenue recognition begins. When charge model is `Overage` or `TieredWithOverage`, `smoothingModel` will be one of the following values: * `ContractEffectiveDate` * `ServiceActivationDate` * `CustomerAcceptanceDate` |
[optional] |
| specific_billing_period |
Integer |
Customizes the number of month or week for the charges billing period. This field is required if you set the value of the `BillingPeriod` field to `Specific_Months` or `Specific_Weeks`. |
[optional] |
| specific_end_date |
Date |
The specific date on which the charge ends. If the subscription ends before the specific 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 specific end date. |
[optional] |
| tcv |
String |
The total contract value. |
[optional] |
| tiers |
Array<GETTierType> |
One or many defined ranges with distinct pricing. |
[optional] |
| trigger_date |
Date |
The date that the rate plan charge will be triggered. |
[optional] |
| trigger_event |
String |
The event that will cause the rate plan charge to be triggered. Possible values: * `ContractEffective` * `ServiceActivation` * `CustomerAcceptance` * `SpecificDate` |
[optional] |
| type |
String |
Charge type. Possible values are: `OneTime`, `Recurring`, `Usage`. |
[optional] |
| unused_units_credit_rates |
String |
Specifies the rate to credit a customer for unused units of usage. This field is applicable only for overage charge models when the `OverageUnusedUnitsCreditOption` field value is `CreditBySpecificRate`. |
[optional] |
| uom |
String |
Specifies the units to measure usage. |
[optional] |
| up_to_periods |
String |
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. If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. |
[optional] |
| up_to_periods_type |
String |
The period type used to define when the charge ends. Values: * `Billing_Periods` * `Days` * `Weeks` * `Months` * `Years` |
[optional] |
| usage_record_rating_option |
String |
Determines how Zuora processes usage records for per-unit usage charges. |
[optional] |
| version |
Integer |
Rate plan charge revision number. |
[optional] |