This API is used to generate an invoice estimate for preview. Estimate details include the number of billing cycles to be invoiced in advance, the number of billing cycles in one interval, advance invoicing schedules, and so on.
Sample Request
Sample Result[JSON]
URL Format
Input Parameters
- For
schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for theremaining_billing_cyclesof the subscription if that is less thanterms_to_charge. - For
schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription. .
Whether the charge should be invoiced immediately or added to unbilled_charges.
Applicable only when schedule_type
is immediate
.
The type of advance invoice or advance invoicing schedule.
Charge immediately for the number of billing cycles specified by terms_to_charge
.
Charge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured.
Charge at fixed intervals of time. Specify the number of billing cycles that constitute an interval and the number of days before each interval that the invoice should be generated. Also specify when the schedule should end .