Settings
Configure SDK
Estimates
Estimates, as the name implies, can be used to find out the estimate for performing an operation as against performing the operation itself. i.e Say you want to create a new subscription or update an existing one, using the estimate API one can deduce the details like how much money the customer needs to be charged for this operation, when it should be collected, the state the subscription would be in etc. Note:
- Invoking these APIs do not perform the actual operation but just generates an estimate.
- Prorated Credits and Promotional Credits are not taken into account while generating the estimate.
Sample estimate [ JSON ]
{
"amount": 895,
"amount_due": 895,
"collect_now": true,
"created_at": 1517506678,
"credits_applied": 0,
"line_items": [
{
"amount": 895,
"date_from": 1517506678,
"date_to": 1519925878,
"description": "No Trial",
"entity_id": "no_trial",
"entity_type": "plan",
"is_taxed": false,
"object": "line_item",
"quantity": 1,
"tax": 0,
"type": "charge",
"unit_amount": 895
}
],
"object": "estimate",
"price_type": "tax_exclusive",
"recurring": true,
"sub_total": 895,
"subscription_status": "active",
"term_ends_at": 1519925878
}The list of items in this estimate
The list of discounts applied to this estimate
The list of taxes applied to this estimate
Create subscription estimate ¶
Generates an estimate for the 'create subscription' operation. This input will be similar to the Create Subscription API but no subscription will be created, but just an estimate will be generated. Note:
- If you use the EU VAT tax option, you need to specify 'billing_address[country]' and 'customer[vat_number]' attributes for the tax calculation to happen. If these attributes are not passed, the tax will be ignored for this estimate.
- If you use the Customized Tax option, you need to specify the shipping address and billing address parameters for the tax calculation to happen. This is because Chargebee will use the customer's shipping address to determine the tax applicable. If the shipping address is not available, then the billing address will be used to determine tax. If both addresses are not available, tax will be ignored for this estimate.
Related Tutorial
Sample Response [ JSON ]
URL Format POST
Input Parameters
pass parameters as subscription[<param name>]
Returns
Resource object representing estimate
Create subscription for a customer estimate ¶
Create a subscription for the existing estimate of a customer.
Sample Response [ JSON ]
URL Format GET
Input Parameters
pass parameters as subscription[<param name>]
Returns
Resource object representing estimate
Update subscription estimate ¶
Generates an estimate for the 'update subscription' operation. The input will be similar to the Update Subscription API but subscription will not be updated, but just an estimate will be generated.
In case 'update subscription' operation will not create an invoice immediately, the estimate generated will be for the 'end of term' invoice. Some of the cases where the invoice will not be generated immediately are
- In case of downgrades only credits will be added to customer.
- 'end_of_term' option is true.
- 'prorate' option is false.
- Only coupon is applied.
Note:
- If you use the EU VAT tax option, you need to specify 'billing_address[country]' and 'customer[vat_number]' attributes for the tax calculation to happen. If these attributes are not passed, the tax will be ignored for this estimate.
- If you use the Customized Tax option, you need to specify the shipping address and billing address parameters for the tax calculation to happen. This is because Chargebee will use the customer's shipping address to determine the tax applicable. If the shipping address is not available, then the billing address will be used to determine tax. If both addresses are not available, tax will be ignored for this estimate.
Sample Response [ JSON ]
URL Format POST
Input Parameters
- When
true: Prorated credits or charges are created as applicable for this change. - When
false: The subscription is changed without creating any credits or charges. - When not provided, the value configured in the site settings is considered.
Caveat
For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:
An immediate previous change was made
- with
prorateset tofalseand - no changes were made to the subscription's billing term and
- a change was made to either the subscription's plan, its addons, or the prices of the plan or addons.
pass parameters as subscription[<param name>]
pass parameters as addons[<param name>][<idx:0..n>]
Returns
Resource object representing estimate
Subscription renewal estimate ¶
This returns an estimate of the amount that will be charged when the subscription renews. The estimate is calculated based on the items present in the subscription. This includes the plan, addons and coupons(if any) of the subscription. This API is not supported for "Cancelled" subscriptions.
You can also specify whether you need the estimate to include delayed charges.
For "Non Renewing" subscriptions, only delayed charges(one time charges and non renewing addons) that may have been added to the subscription to be charged at the end of the current term will be included. Plan, addons and coupons(if any) of the subscription will not be included.
This API will not generate a renewal invoice if an advance invoice is already present for the subscription.
Sample Response [ JSON ]
URL Format GET
Input Parameters
Returns
Resource object representing estimate
Create invoice estimate ¶
Generates an estimate for the 'create an invoice' operation. This is similar to the Create an invoice API, but the invoice will not be generated. Only an estimate for this operation is created.
Sample Response [ JSON ]
URL Format POST
Input Parameters
pass parameters as shipping_address[<param name>]
Returns
Resource object representing estimate