Create prepayment charge with rollover - REST API
Learn how to use the REST API to create a prepayment charge with rollover, including mandatory fields and requirements.
You can use REST API to create a prepayment charge with rollover. Note that WSDL version 114+ is required for the X-Zuora-WSDL-Version header parameter. Determine the following mandatory fields specific to a prepayment charge:
|
Field name |
Type |
Description |
|---|---|---|
|
isRollover |
boolean |
The value is either "True" or "False". It determines whether the rollover fields are needed. |
|
rolloverApply |
string |
This field defines the priority of rollover, which is either first or last. Enum: |
|
rolloverPeriods |
number |
Defines the number of rollover periods. This value is restricted to 3. When you set rolloverPeriodLength to a value greater than 0, you must set rolloverPeriods to 1 so that the rollover happens exactly once. |
|
rolloverPeriodLength |
integer |
Specifies, in months, the validity period of the rollover funds when you want it to be shorter than the prepayment charge's original validity period. For example, if the prepaid validity period is annual and rolloverPeriodLength is 2, the rolled-over funds are valid for 2 months instead of 12 months. When rolloverPeriodLength is greater than 0, rolloverPeriods must be 1, and the rollover validity period itself cannot be rolled over again. |