ProxyGetProductRatePlanCharge.md

Zuora::ProxyGetProductRatePlanCharge

Properties

Name	Type	Description	Notes
accounting_code	String	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	String	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	Integer	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	String	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	String	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	String	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	String	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	String	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]
charge_type	String	Specifies the type of charge. Character limit: 9 Values: one of the following: - `OneTime` - `Recurring` - `Usage`	[optional]
created_by_id	String	The ID of the Zuora user who created the `ProductRatePlanCharge` object. Character limit: 32 Values: automatically generated	[optional]
created_date	DateTime	The date when the `ProductRatePlanCharge` object was created. Character limit: 29 Values: automatically generated	[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	String	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	String	A description of the charge. Character limit: 500 Values: a string of 500 characters or fewer	[optional]
discount_level	String	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	String	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]
id	String	Object identifier.	[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	BOOLEAN		[optional]
list_price_base	String	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	String	The name of the product rate plan charge. Character limit: 100 Values: a string of 100 characters or fewer	[optional]
number_of_period	Integer	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	String	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	String	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	String	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_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	String	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	String	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	String	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	String	Specifies when revenue recognition begins. Character limit: 22 Values: one of the following: - `ContractEffectiveDate` - `ServiceActivationDate` - `CustomerAcceptanceDate`	[optional]
revenue_recognition_rule_name	String	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	String	Specifies the smoothing model for an overage smoothing charge model. Character limit: 22 Values: one of the following: - `RollingWindow` - `Rollover`	[optional]
specific_billing_period	Integer	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	String	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	String	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	BOOLEAN	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	String	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	String	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	Integer	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	String	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]
updated_by_id	String	The ID of the last user to update the object. Character limit: 32 Values: automatically generated	[optional]
updated_date	DateTime	The date when the object was last updated. Character limit: 29 Values: automatically generated	[optional]
use_discount_specific_accounting_code	BOOLEAN	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	BOOLEAN	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	String	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]