GET /subscriptions/{subscription-id}/renewal_estimate

This returns an estimate of the amount that will be charged when the subscription is billed next. The estimate is calculated based on the current recurring items of the subscription - plan, addons, and coupons.

In the response,

estimate.subscription_estimate has the current subscription details like its status, next billing date, and so on.

estimate.invoice_estimate has details of the invoice that will be generated at the next billing date.
The generated invoice estimate will include all the balances - Promotional Credits , Refundable Credits, and Excess Payments - if any. If you don't want these balances to be included you can specify 'false' for the parameter use_existing_balances .
To exclude the delayed charges from the invoice estimate, specify 'false' for the parameter include_delayed_charges .

Note:

This API will not generate a renewal invoice if an advance invoice is already present for the subscription.
For 'Non Renewing' subscriptions, only the delayed charges will be included in the invoice estimate.
This API is not supported for 'Cancelled' subscriptions.
Only the subscription's charges will be included. If you have enabled the Consolidated invoicing feature, use the Upcoming Invoices estimate available for the Customer object to get the actual estimate invoice for the customer.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`subscription-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

Query parameters

Name	Type	Required	Description
`include_delayed_charges`	Boolean	No	If true, all the unbilled charges will be included for the invoice estimate. Default value: true
`ignore_scheduled_cancellation`	Boolean	No	if true, ignores scheduled cancellation for non renewing subscription. Default value: false
`ignore_scheduled_changes`	Boolean	No	If true, ignores all recurring charges scheduled during renewal. Default value: false
`exclude_tax_type`	String	No	Indicates whether tax calculation should be excluded for the operation. This attribute is applicable only when a third-party tax provider is configured. If no such provider is set up, this parameter will be ignored. * exclusive - Excludes only exclusive tax calculations, and only when exclusive taxes are applicable. * none - No exclusions are applied. All applicable taxes are calculated based on the standard tax configuration. Valid values: `"exclusive"` `"none"` Default value: "none"
`use_existing_balances`	Boolean	No	The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don't want these balances to be included you can specify 'false' for the parameter `use_existing_balances`. Default value: true

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.