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.

API Index URL

https://[site].chargebee.com/api/v1/estimates

Estimates attributes

created_at

required, timestamp(UTC) in seconds

The time at which this estimate got generated

recurring

required, boolean, default=true

Whether or not the estimate for the invoice is recurring. Will be 'true' or 'false' for subscription related estimates.

subscription_id

optional, string, max chars=100

Applicable only for subsctiption related estimates. The identifier of the subscription this estimate belongs to.

subscription_status

optional, enumerated string

Applicable only for subsctiption related estimates. The post-operation status of the subscription.

Enum Values

future

The subscription is scheduled to start at a future date.

in_trial

The subscription is in trial.

active

The subscription is active and will be charged for automatically based on the items in it.

non_renewing

The subscription will be canceled at the end of the current term.

cancelled

The subscription has been canceled and is no longer in service.

transferred

term_ends_at

optional, timestamp(UTC) in seconds

Applicable only for subsctiption related estimates. End of the current billing term

collect_now

required, boolean

'true' means the estimate amount needs to be collected immediately, whereas 'false' means the estimate amount needs to be collected at the term-end

price_type

required, enumerated string, default=tax_exclusive

The price type of the invoice.

Enum Values

tax_exclusive

All amounts in the document are exclusive of tax.

tax_inclusive

All amounts in the document are inclusive of tax.

amount

required, in cents, default=0, min=0

Total estimate amount in cents. The 'collect_now' field indicates when this amount needs to be collected.

credits_applied

required, in cents, default=0, min=0

credits applied to this invoice in cents.

amount_due

required, in cents, default=0, min=0

Invoice amount due in cents

sub_total

required, in cents, min=0

The sub-total amount

line_items

The list of items in this estimate

discounts

The list of discounts applied to this estimate

taxes

The list of taxes applied to this estimate