Estimate of the upcoming scheduled invoices (subscription activations, renewals etc) of a customer. For now preview of the invoices generated on the immediate upcoming date is supported. Say a customer has couple of subscription renewals scheduled on Jan,10th and another subscription renewal scheduled on Jan,15th. This API gives the preview of all the invoices scheduled to be generated on Jan,10th (immediate upcoming date).
In the response:
- estimate.invoice_estimates[] has details of the invoices scheduled to be generated.
Note: If consolidated invoicing is enabled you may use this API to test whether upcoming renewals are consolidated.
Sample Request
Sample Result[JSON]
URL Format
Input Parameters
When set to true, the invoice_estimates[] returned in the response includes usage-based line items, if any. These are invoice_estimates[].line_items[] where line_items[].metered is true.
See also:
Pricing for usage-based line items.