POSTScCreateType.md

POSTScCreateType

Properties

Name	Type	Description	Notes
apply_discount_to	str	Specifies the type of charges that you want a specific discount to apply to. Values: * `ONETIME` * `RECURRING` * `USAGE` * `ONETIMERECURRING` * `ONETIMEUSAGE` * `RECURRINGUSAGE` * `ONETIMERECURRINGUSAGE`	[optional]
bill_cycle_day	str	Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed. Values: `1`-`31`	[optional]
bill_cycle_type	str	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`	[optional]
billing_period	str	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`	[optional]
billing_period_alignment	str	Aligns charges within the same subscription if multiple charges begin on different dates. Values: * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart`	[optional]
billing_timing	str	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]
description	str	Description of the charge.	[optional]
discount_amount	str	Specifies the amount of fixed-amount discount.	[optional]
discount_level	str	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`	[optional]
discount_percentage	str	Percentage of discount for a percentage discount.	[optional]
end_date_condition	str	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	str	Specifies the number of units in the base set of units for this charge. Must be >=`0`.	[optional]
list_price_base	str	The list price base for the product rate plan charge. Values: * `Per_Billing_Period` * `Per_Month` * `Per_Week`	[optional]
number	str	Unique number that identifies the charge. Max 50 characters. System-generated if not provided.	[optional]
number_of_periods	int	Specifies the number of periods to use when calculating charges in an overage smoothing charge model.	[optional]
overage_price	str	Price for units over the allowed amount.	[optional]
overage_unused_units_credit_option	str	Determines whether to credit the customer with unused units of usage. Values: * `NoCredit` * `CreditBySpecificRate`	[optional]
price	str	Price for units in the subscription rate plan.	[optional]
price_change_option	str	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`	[optional]
price_increase_percentage	str	Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`. Value must be a decimal between `-100` and `100`.	[optional]
product_rate_plan_charge_id	str	ID of a product rate-plan charge for this subscription.
quantity	str	Number of units. Must be a decimal >=`0`. When using `chargeOverrides` for creating subscriptions with recurring charge types, the `quantity` field must be populated when the charge model is "Tiered Pricing" or "Volume Pricing". It is not required for "Flat Fee Pricing" charge model.	[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]
specific_billing_period	int	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`.	[optional]
specific_end_date	date	Defines when the charge ends after the charge trigger date. note: * 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	list[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	str	Specifies when to start billing the customer for the charge. Values: * `UCE` * `USA` * `UCA` * `USD`	[optional]
unused_units_credit_rates	str	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`.	[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. 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 `Fixed_Period`. * 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. 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]
weekly_bill_cycle_day	str	Specifies which day of the week is the bill cycle day (BCD) for the charge. Values: * `Sunday` * `Monday` * `Tuesday` * `Wednesday` * `Thursday` * `Friday` * `Saturday`	[optional]

[Back to Model list] [Back to API list] [Back to README]