Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 3.4 KB

PUTScUpdateType.md

File metadata and controls

20 lines (17 loc) · 3.4 KB

Zuora::PUTScUpdateType

Properties

Name Type Description Notes
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]
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]
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]
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]
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 Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field. 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]
quantity String Quantity of units; must be greater than zero. [optional]
rate_plan_charge_id String ID of a rate-plan charge for this subscription.
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. `triggerDate` cannot be updated for the following using the REST update subscription call: * One-time charge type * Discount-Fixed Amount charge model * Discount-Percentage charge model [optional]
trigger_event String Specifies when to start billing the customer for the charge. Values: * `UCE` * `USA` * `UCA` * `USD` This is the date when charge changes in the REST request become effective. `triggerEvent` cannot be updated for the following using the REST update subscription call: * One-time charge type * Discount-Fixed Amount charge model * Discount-Percentage charge model [optional]