| class__ns |
str |
Class associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[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. |
[optional] |
| department__ns |
str |
Department associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| include_children__ns |
str |
Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| integration_id__ns |
str |
ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| integration_status__ns |
str |
Status of the product rate plan charge's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| item_type__ns |
str |
Type of item that is created in NetSuite for the product rate plan charge. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| location__ns |
str |
Location associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[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. |
[optional] |
| rev_rec_end__ns |
str |
End date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| rev_rec_start__ns |
str |
Start date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| rev_rec_template_type__ns |
str |
Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| subsidiary__ns |
str |
Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[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. |
[optional] |
| accounting_code |
str |
The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. Character limit: 100 Values: an active accounting code in your Zuora Chart of Accounts |
[optional] |
| apply_discount_to |
str |
Specifies the type of charges that you want a specific discount to apply to. All field values are case sensitive: note that these values are in all-caps. Character limit: 21 Values: one of the following: - `ONETIME (1)` - `RECURRING (2)` - `USAGE (4)` - `ONETIMERECURRING (3)` - `ONETIMEUSAGE (5)` - `RECURRINGUSAGE (6)` - `ONETIMERECURRINGUSAGE (7)` |
[optional] |
| bill_cycle_day |
int |
Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object. Character limit: 2 Values: a valid BCD integer, 1 - 31 |
[optional] |
| bill_cycle_type |
str |
Specifies how to determine the billing day for the charge. Character limit: 20 Values: one of the following: - `DefaultFromCustomer` - `SpecificDayofMonth:` - `SubscriptionStartDay` - `ChargeTriggerDay` - `SpecificDayofWeek` Note: - If you set this field to `SpecificDayofMonth`, you must specify which day of the month as the billing day for the charge in the BillCycleDay field. - If you set this field to `SpecificDayofWeek`, you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field. |
[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). Character limit: 15 Values: one of the following - `Month` - `Quarter` - `Annual` - `Semi-Annual` - `Specific Months` - `Subscription Term` (This value is in Limited Availability.) - `Week` - `Specific Weeks` Note: Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to `Specific Months` or `Specific Weeks`. |
[optional] |
| billing_period_alignment |
str |
Aligns charges within the same subscription if multiple charges begin on different dates. Character limit: 24 Values: one of the following: - `AlignToCharge` - `AlignToSubscriptionStart` - `AlignToTermStart` |
[optional] |
| billing_timing |
str |
The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types. Character limit: Values: one of the following: - `In Advance` - `In Arrears` This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. |
[optional] |
| charge_model |
str |
Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration. Character limit: 27 Values: one of the following: - `Discount-Fixed Amount` - `Discount-Percentage` - `Flat Fee Pricing` - `Per Unit Pricing` - `Overage Pricing` - `Tiered Pricing` - `Tiered with Overage Pricing` - `Volume Pricing` |
[optional] |
| default_quantity |
float |
The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model. Character limit: 16 Values: a valid quantity value |
[optional] |
| deferred_revenue_account |
str |
The name of the deferred revenue account for this charge. Character limit: 100 Values: an active accounting code in your Zuora Chart of Accounts This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. |
[optional] |
| description |
str |
A description of the charge. Character limit: 500 Values: a string of 500 characters or fewer |
[optional] |
| discount_level |
str |
Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account. Character limit: 12 Values: one of the following: - `rateplan` - `subscription`, `account` |
[optional] |
| end_date_condition |
str |
Defines when the charge ends after the charge trigger date. Values: one of the following: - `SubscriptionEnd`: The charge ends on the subscription end date after a specified period based on the trigger date of the charge. This is the default value. - `FixedPeriod`: The charge ends after a specified period based on the trigger date of the charge. If you set this field to `FixedPeriod`, you must specify the length of the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType` fields. Note: 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. |
[optional] |
| included_units |
float |
Specifies the number of units in the base set of units. Character limit: 16 Values: a positive decimal value |
[optional] |
| legacy_revenue_reporting |
bool |
|
[optional] |
| list_price_base |
str |
The list price base for the product rate plan charge. Values: one of the following: - `Per Month` - `Per Billing Period` - `Per Week` |
[optional] |
| max_quantity |
float |
Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge. Character limit: 16 Values: a positive decimal value |
[optional] |
| min_quantity |
float |
Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge. Character limit: 16 Values: a positive decimal value |
[optional] |
| name |
str |
The name of the product rate plan charge. Character limit: 100 Values: a string of 100 characters or fewer |
[optional] |
| number_of_period |
int |
Specifies the number of periods to use when calculating charges in an overage smoothing charge model. Character limit: Values: a positive whole number |
[optional] |
| overage_calculation_option |
str |
Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored. Character limit: 20 Values: one of the following: - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period. - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period. |
[optional] |
| overage_unused_units_credit_option |
str |
Determines whether to credit the customer with unused units of usage. Character limit: 20 Values: one of the following: - `NoCredit` - `CreditBySpecificRate` |
[optional] |
| price_change_option |
str |
Applies an automatic price change when a termed subscription is renewed. Character limit: Values: one of the following: - `NoChange` (default) - `SpecificPercentageValue` - `UseLatestProductCatalogPricing` |
[optional] |
| price_increase_option |
str |
Applies an automatic price change when a termed subscription is renewed. |
[optional] |
| price_increase_percentage |
float |
Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`. Character limit: 16 Values: a decimal value between -100 and 100 |
[optional] |
| product_rate_plan_id |
str |
The ID of the product rate plan associated with this product rate plan charge. Character limit: 32 Values: a valid product rate plan ID |
[optional] |
| recognized_revenue_account |
str |
The name of the recognized revenue account for this charge. - Required when the Allow Blank Accounting Code setting is No. - Optional when the Allow Blank Accounting Code setting is Yes. Character limit: 100 Values: an active accounting code in your Zuora Chart of Accounts This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. |
[optional] |
| rev_rec_code |
str |
Associates this product rate plan charge with a specific revenue recognition code. Character limit: 70 Values: a valid revenue recognition code |
[optional] |
| rev_rec_trigger_condition |
str |
Specifies when revenue recognition begins. Character limit: 22 Values: one of the following: - `ContractEffectiveDate` - `ServiceActivationDate` - `CustomerAcceptanceDate` |
[optional] |
| revenue_recognition_rule_name |
str |
Determines when to recognize the revenue for this charge. Character limit: 25 Values: one of the following: - `Recognize upon invoicing` - `Recognize daily over time` |
[optional] |
| smoothing_model |
str |
Specifies the smoothing model for an overage smoothing charge model. Character limit: 22 Values: one of the following: - `RollingWindow` - `Rollover` |
[optional] |
| specific_billing_period |
int |
Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`. Values: a positive integer |
[optional] |
| tax_code |
str |
Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`. Character limit: 64 Values: a valid tax code Note: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`. |
[optional] |
| tax_mode |
str |
Determines how to define taxation for the charge. Required when the Taxable field is set to `True`. Character limit: 12 Values: one of the following: - `TaxExclusive` - `TaxInclusive` Note: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`. |
[optional] |
| taxable |
bool |
Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object. Character limit: 5 Values: `True`, `False` Note: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`. |
[optional] |
| trigger_event |
str |
Specifies when to start billing the customer for the charge. Character limit: 18 Values: one of the following: - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed. - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access. - `CustomerAcceptance` is when the customer accepts the services or products for a subscription. |
[optional] |
| uom |
str |
Specifies the units to measure usage. Character limit: 25 Values: a configured unit of measure Note: You must specify this field when creating the following charge models: - Per Unit Pricing - Volume Pricing - Overage Pricing - Tiered Pricing - Tiered with Overage Pricing |
[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. Character limit: 5 Values: a whole number between 0 and 65535, exclusive Note: - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. - 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 |
str |
The period type used to define when the charge ends. Character limit: -- Values: one of the following: - `Billing Periods` (default) - `Days` - `Weeks` - `Months` - Years Note: - You must use this field together with the `UpToPeriods` field to specify the time period. - This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. |
[optional] |
| usage_record_rating_option |
str |
Determines how Zuora processes usage records for per-unit usage charges. |
[optional] [default to 'EndOfBillingPeriod'] |
| use_discount_specific_accounting_code |
bool |
Determines whether to define a new accounting code for the new discount charge. Character limit: 5 Values: `True`, `False` |
[optional] |
| use_tenant_default_for_price_change |
bool |
Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. Character limit: 5 Values: `true`, `false` |
[optional] |
| weekly_bill_cycle_day |
str |
Specifies which day of the week as the bill cycle day (BCD) for the charge. This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Values: one of the following: - `Sunday` - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` |
[optional] |
| rating_group |
str |
Specifies a rating group based on which usage records are rated. Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Possible values: - `ByBillingPeriod` (default): The rating is based on all the usages in a billing period. - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. - `ByUsageRecord`: The rating is based on each usage record. - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`). - `ByGroupId`: The rating is based on all the usages in a custom group. Note: - The `ByBillingPeriod` value can be applied for all charge models. - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. - The `ByGroupId` value is only available if you have Real-Time Usage Rating feature enabled. - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`. |
[optional] |