PUTScAddType.md

Zuora::PUTScAddType

Properties

Name	Type	Description	Notes
apply_discount_to	String	Specifies the type of charges that you want a specific discount to apply to. Values: * `ONETIME` * `RECURRING` * `USAGE` * `ONETIMERECURRING` * `ONETIMEUSAGE` * `RECURRINGUSAGE` * `ONETIMERECURRINGUSAGE` Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models: * Recurring	[optional]
bill_cycle_day	String	Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. Values: `1`-`31` Available for the following charge types: * Recurring * Usage-based	[optional]
bill_cycle_type	String	Specifies how to determine the billing day for the charge. When this field is set to `SpecificDayOfMonth`, set the `BillCycleDay` field. When this field is set to `SpecificDayOfWeek`, set the `weeklyBillCycleDay` field. Values: * `DefaultFromCustomer` * `SpecificDayOfMonth` * `SubscriptionStartDay` * `ChargeTriggerDay` * `SpecificDayOfWeek` Available for the following charge types: * Recurring * Usage-based	[optional]
billing_period	String	Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). Values: * `Month` * `Quarter` * `Semi_Annual` * `Annual` * `Eighteen_Months` * `Two_Years` * `Three_Years` * `Five_Years` * `Specific_Months` * `Subscription_Term` * `Week` * `Specific_Weeks` Available for the following charge types: * Recurring * Usage-based	[optional]
billing_period_alignment	String	Aligns charges within the same subscription if multiple charges begin on different dates. Values: * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart` Available for the following charge types: * Recurring * Usage-based	[optional]
billing_timing	String	Billing timing for the charge for recurring charge types. Not avaliable for one time, usage and discount charges. Values: * `IN_ADVANCE` (default) * `IN_ARREARS`	[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 charge.	[optional]
discount_amount	String	Specifies the amount of fixed-amount discount. Available for the following charge type for the Discount-Fixed Amount charge model: * Recurring	[optional]
discount_level	String	Specifies if the discount applies to the product rate plan only , the entire subscription, or to any activity in the account. Values: * `rateplan` * `subscription` * `account` Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models: * Recurring	[optional]
discount_percentage	String	Specifies the percentage of a percentage discount. Available for the following charge type for the Discount-Percentage charge model: * Recurring	[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]
included_units	String	Specifies the number of units in the base set of units for this charge. Must be >=`0`. Available for the following charge types for the Overage charge model: * Recurring * Usage-based	[optional]
list_price_base	String	The list price base for the product rate plan charge. Values: * `Per_Billing_Period` * `Per_Month` * `Per_Week` Available for the following charge type for the Flat Fee, Per Unit, Volume Pricing, and Tiered Pricing charge models: * Recurring	[optional]
number	String	Unique number that identifies the charge. System-generated if not provided.	[optional]
number_of_periods	Integer	Specifies the number of periods to use when calculating charges in an overage smoothing charge model. Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based	[optional]
overage_price	String	Price for units over the allowed amount. Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based	[optional]
overage_unused_units_credit_option	String	Determines whether to credit the customer with unused units of usage. Values: * `NoCredit` * `CreditBySpecificRate` Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based	[optional]
price	String	Price for units in the subscription rate plan. Supports all charge types for the Flat Fee and Per Unit charge models	[optional]
price_change_option	String	Applies an automatic price change when a termed subscription is renewed. The Zuora Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field. See Define Default Subscription Settings for more information on setting this option. Values: * `NoChange` (default) * `SpecificPercentageValue` * `UseLatestProductCatalogPricing` Available for the following charge types: * Recurring * Usage-based * Not available for the Fixed-Amount Discount charge model.	[optional]
price_increase_percentage	String	Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`. Decimal between -100 and 100. Available for the following charge types: * Recurring * Usage-based Not available for the Fixed-Amount Discount charge model.	[optional]
product_rate_plan_charge_id	String
quantity	String	Number of units. Must be >=`0`. Available for the following charge types for the Per Unit, Volume Pricing, and Tiered Pricing charge models: * One-time * Recurring	[optional]
rating_group	String	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. 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). 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. Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.	[optional]
specific_billing_period	Integer	Specifies the number of month or week for the charges billing period. Required if you set the value of the `billingPeriod` field to `Specific_Months` or `Specific_Weeks`. Available for the following charge types: * Recurring * Usage-based	[optional]
specific_end_date	Date	Defines when the charge ends after the charge trigger date. This field is only applicable when the `endDateCondition` field is set to `Specific_End_Date`. 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]
tiers	Array<POSTTierType>	Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types: * One-time * Recurring * Usage-based	[optional]
trigger_date	Date	Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to `USD`.	[optional]
trigger_event	String	Specifies when to start billing the customer for the charge. Values: * `UCE` * `USA` * `UCA` * `USD`	[optional]
unused_units_credit_rates	String	Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the `OverageUnusedUnitsCreditOption` field is set to `CreditBySpecificRate`. Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based	[optional]
up_to_periods	Integer	The period type used to define when the charge ends. Values: * `Billing_Periods` * `Days` * `Weeks` * `Months` * `Years` 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 `Fixed_Period`.	[optional]
up_to_periods_type	String	The period type used to define when the charge ends. Values: * `Billing_Periods` * `Days` * `Weeks` * `Months` * `Years` 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 `Fixed_Period`.	[optional]