Estimates

During the process of signing up customers to subscriptions, use the Estimates API to evaluate the details of the purchase before actually signing them up. The details returned by the API include the invoice amounts, next billing date and unbilled charges.

For example, consider that you are creating a new subscription or update an existing one. Use the Estimates API before that to deduce the details such as the amount the customer would be charged, the state the subscription would be in after creation or updation, and so on.

If you have configured the Avalara integration, Chargebee retrieves the tax amount from Avalara for the invoice. This counts against your Avalara API limits.

Sample estimate [ JSON ]

{
    "created_at": 1517505710,
    "invoice_estimate": {
        "amount_due": 895,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWl2E82aS",
        "date": 1517505710,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [{
            "amount": 895,
            "customer_id": "__test__KyVnHhSBWl2E82aS",
            "date_from": 1517505710,
            "date_to": 1519924910,
            "description": "No Trial",
            "discount_amount": 0,
            "entity_id": "no_trial",
            "entity_type": "plan",
            "id": "li___test__KyVnHhSBWl2Eq2aU",
            "is_taxed": false,
            "item_level_discount_amount": 0,
            "object": "line_item",
            "pricing_model": "per_unit",
            "quantity": 1,
            "tax_amount": 0,
            "unit_amount": 895
        }],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 895,
        "taxes": [],
        "total": 895
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1519924910,
        "object": "subscription_estimate",
        "status": "active"
    }
}

created_at

timestamp(UTC) in seconds
The time at which this estimate got generated

subscription_estimate

optional, subscription_estimate
Represents the subscription details when the 'estimate' operations are invoked.

subscription_estimates

optional, list of subscription_estimate
Is a list of estimated subscriptions i.e., an array of subscription_estimate objects. It is generated when 'Create an estimate for purchase' operation is invoked

invoice_estimate

optional, invoice_estimate
Represents the preview of the invoice generated immediately when the 'estimate' operations are invoked.

invoice_estimates

optional, list of invoice_estimate
Is a list of estimated invoices i.e., an array of invoice_estimate objects. It is generated when 'Create an estimate for unbilled charges' operation is invoked

next_invoice_estimate

optional, invoice_estimate
Represents the preview of the invoice generated at term end when the 'estimate' operations are invoked.

credit_note_estimates

optional, list of credit_note_estimate
Represents the preview of the credit-notes generated during 'estimate' operation. Currently applicable only for the 'Update Subscription Estimate' operation.

unbilled_charge_estimates

optional, list of unbilled_charge
Represents the preview of the unbilled charges generated during 'estimate' operation. Currently not applicable for the ‘Subscription renewal estimate’ operation.

id

optional, string, max chars=50
The identifier of the subscription

currency_code

string, max chars=3
The currency code (ISO 4217 format) of the subscription.

status

optional, enumerated string
The status of the subscription.

Possible values are

futureThe subscription is scheduled to start at a future date.in_trialThe subscription is in trial.activeThe subscription is active and will be charged for automatically based on the items in it.non_renewingThe subscription will be canceled at the end of the current term.pausedThe subscription is paused. The subscription will not renew while in this state.cancelledThe subscription has been canceled and is no longer in service.

trial_end_action

optional, enumerated string
Applicable only when End-of-trial Action has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.

Possible values are

site_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is not defined for the plan.plan_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is defined for the plan.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.

next_billing_at

optional, timestamp(UTC) in seconds
Date on which the next billing happens. This will be null for non-renewing and cancelled subscriptions.

pause_date

optional, timestamp(UTC) in seconds
The date on which subscription will be paused. Applicable only to paused or scheduled pause subscriptions

resume_date

optional, timestamp(UTC) in seconds
The date on which subscription will be resumed. Applicable only to paused or scheduled pause subscriptions

shipping_address
Show attributes[+]

optional, shipping_address
Represents the shipping address when the 'estimate' operations are invoked.

Shipping address attributes

first_name

optional, string, max chars=150
The first name of the contact.

last_name

optional, string, max chars=150
The last name of the contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).

state

optional, string, max chars=50
The state/province name.

country

optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note: If you enter an invalid country code, the system will return an error.

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.

index

integer, min=0
The index number of the subscription to which the item price is added. Provide a unique number between 0 and 4 (inclusive) for each subscription that is to be created.

contract_term
Show attributes[+]

optional, contract_term
Represents the contract terms when the 'estimate' operations are invoked.

Contract term attributes

id

string, max chars=50
Id that uniquely identifies the contract term in the site.

status

enumerated string
Current status of contract

Possible values are

activeAn actively running contract term.completedThe contract term has run its full duration.cancelledThe contract term was ended because:

a change in the subscription caused a subscription term reset.
the subscription was cancelled due to non-payment.

terminatedThe contract term was terminated ahead of completion.

contract_start

timestamp(UTC) in seconds
The start date of the contract term

contract_end

timestamp(UTC) in seconds
The end date of the contract term

billing_cycle

integer, min=0
The number of billing cycles of the subscription that the contract term is for.

action_at_term_end

enumerated string, default=renew
Action to be taken when the contract term completes.

Possible values are

renew

Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.

The action_at_term_end for the new contract term is set to renew.

evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed when you want to renew the contract term just once. Does the following:

Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.

The action_at_term_end for the new contract term is set to cancel.

total_contract_value

in cents, default=0, min=0
The sum of the totals of all the invoices raised as part of the contract term. For active contract terms, this is a predicted value. The value depends on the type of currency. If the subscription was imported with the contract term, then this value includes the value passed for total_amount_raised.

total_contract_value_before_tax

in cents, default=0, min=0
It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for total_amount_raised_before_tax is included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.

cancellation_cutoff_period

optional, integer
The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure

created_at

timestamp(UTC) in seconds
The date when the contract term was created.

subscription_id

string, max chars=50
The Id of the subscription that this contract term is for.

remaining_billing_cycles

optional, integer, min=0
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active contract terms.

recurring

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

price_type

enumerated string, default=tax_exclusive
The price type of this invoice.

Possible values are

tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.

currency_code

string, max chars=3
The currency code (ISO 4217 format) of the invoice.

sub_total

in cents, min=0
Invoice sub-total in cents.

total

optional, in cents, default=0, min=0
Invoice total in cents.

credits_applied

optional, in cents, default=0, min=0
credits applied to this invoice in cents.

amount_paid

optional, in cents, default=0, min=0
Existing outstanding payments if any, applied to this invoice in cents.

amount_due

optional, in cents, default=0, min=0
Invoice amount due in cents

round_off_amount

optional, in cents, min=0
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount. If there is no round-off amount, it will display 0.

customer_id

optional, string, max chars=100
A unique identifier for the customer this invoice belongs to

line_items
Show attributes[+]

optional, list of line_item
The details of the line items in this invoice estimate.

Note

Line items that meet both the following conditions are not returned:

The line item belongs to an item price whose parent item is metered.
The line_item.amount is 0.

Line item attributes

id

optional, string, max chars=40
Uniquely identifies a line_item

subscription_id

optional, string, max chars=50
A unique identifier for the subscription this line item belongs to.

date_from

timestamp(UTC) in seconds
Start date of this line item.

date_to

timestamp(UTC) in seconds
End date of this line item.

unit_amount

in cents
Unit amount of the line item.

quantity

optional, integer, default=1
Quantity of the recurring item which is represented by this line item.

amount

optional, in cents
Total amount of this line item. Typically equals to unit amount x quantity

pricing_model

optional, enumerated string
The pricing scheme for this item.

Possible values are

flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThe per unit price is based on the tier that the total quantity falls in.volumeThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.stairstepA quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.

is_taxed

boolean, default=false
Specifies whether this line item is taxed or not

tax_amount

optional, in cents, default=0, min=0
The tax amount charged for this item

tax_rate

optional, double, min=0.0, max=100.0
Rate of tax used to calculate tax for this lineitem

unit_amount_in_decimal

optional, string, max chars=39
The decimal representation of the unit amount of the line_item. The value is in major units of the currency. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.

quantity_in_decimal

optional, string, max chars=33
The decimal representation of the quantity of this line_item. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.

amount_in_decimal

optional, string, max chars=39
The decimal representation of the amount for the line_item, in major units of the currency. Typically equals to unit_amount_in_decimal x quantity_in_decimal. Returned when multi-decimal pricing is enabled.

discount_amount

optional, in cents, min=0
Total discounts for this line

item_level_discount_amount

optional, in cents, min=0
Line Item-level discounts for this line.

reference_line_item_id

optional, string, max chars=40
Invoice Reference Line Item ID

description

string, max chars=250
Detailed description about this line item.

entity_description

optional, string, max chars=500
Detailed description about this item.

entity_type

enumerated string
Specifies the modelled entity this line item is based on.

Possible values are

plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan idplanIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan idaddonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon idadhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case

tax_exempt_reason

optional, enumerated string
The reason due to which the line item price/amount is exempted from tax.

Possible values are

tax_not_configuredIf tax is not enabled for the siteregion_non_taxableIf the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdictionexportYou are not registered for tax in the customer’s region. This is also the reason code when both billing_address and shipping_address have not been provided for the customer and subscription respectivelycustomer_exemptIf the Customer is marked as Tax exempt

product_exemptIf the Plan or Addon is marked as Tax exemptzero_ratedIf the rate of tax is 0% and no Sales/ GST tax is collectable for that line itemreverse_chargeIf the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU onlyhigh_value_physical_goodsIf physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be appliedzero_value_itemIf the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.

Show all values[+]

entity_id

optional, string, max chars=100
The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type

customer_id

optional, string, max chars=100
A unique identifier for the customer this line item belongs to

discounts
Show attributes[+]

optional, list of discount
The list of discounts applied to this estimate

Discount attributes

amount

in cents, min=0
The amount deducted. The format of this value depends on the kind of currency.

description

optional, string, max chars=250
Description for this deduction.

line_item_id

optional, string, max chars=40
The unique id of the line item that this deduction is for. Is required when discounts[entity_type] is item_level_coupon or document_level_coupon.

entity_type

enumerated string
The type of deduction and the amount to which it is applied.

Possible values are

item_level_couponThe deduction is due to a coupon applied to line item. The coupon id is passed as entity_id.document_level_couponThe deduction is due to a coupon applied to the invoice sub_total. The coupon id is passed as entity_id.promotional_creditsThe deduction is due to a promotional credit applied to the invoice. prorated_creditsThe deduction is due to a legacy adjustment credit applied to the invoice. The entity_id is null in this case. The legacy credits feature is superseded by adjustment_credit_notes.

entity_id

optional, string, max chars=100
When the deduction is due to a coupon, then this is the id of the coupon.

coupon_set_code

optional, string, max chars=50
The coupon code, if applicable, used to provide the discount. The coupon.id is available in entity_id.

taxes
Show attributes[+]

optional, list of tax
The list of taxes applied to this estimate

Tax attributes

name

string, max chars=100
The name of the tax applied. E.g. GST.

amount

in cents, min=0
The tax amount.

description

optional, string, max chars=250
Description of the tax item.

line_item_taxes
Show attributes[+]

optional, list of line_item_tax
The list of taxes applied on line items

Line item tax attributes

line_item_id

optional, string, max chars=40
The unique reference id of the line item for which the tax is applicable

tax_name

string, max chars=100
The name of the tax applied

tax_rate

double, default=0.0, min=0.0, max=100.0
The rate of tax used to calculate tax amount

is_partial_tax_applied

optional, boolean
Indicates if tax is applied only on a portion of the line item amount.

is_non_compliance_tax

optional, boolean
Indicates the non-compliance tax that should not be reported to the jurisdiction.

taxable_amount

in cents, min=0
Indicates the actual portion of the line item amount that is taxable.

tax_amount

in cents, min=0
The tax amount

tax_juris_type

optional, enumerated string
The type of tax jurisdiction

Possible values are

countryThe tax jurisdiction is a countryfederalThe tax jurisdiction is a federalstateThe tax jurisdiction is a statecountyThe tax jurisdiction is a countycityThe tax jurisdiction is a cityspecialSpecial tax jurisdiction.unincorporatedCombined tax of state and county.otherJurisdictions other than the ones listed above.

tax_juris_name

optional, string, max chars=250
The name of the tax jurisdiction

tax_juris_code

optional, string, max chars=250
The tax jurisdiction code

tax_amount_in_local_currency

optional, in cents, min=0
Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.

local_currency_code

optional, string, max chars=3
The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.

line_item_tiers
Show attributes[+]

optional, list of line_item_tier
The list of tiers applicable for this line item

Line item tier attributes

line_item_id

optional, string, max chars=40
Uniquely identifies a line_item

starting_unit

integer, min=0
The lower limit of a range of units for the tier

ending_unit

optional, integer
The upper limit of a range of units for the tier

quantity_used

integer, min=0
The number of units purchased in a range.

unit_amount

in cents, min=0
The price of the tier if the charge model is a stairtstep pricing , or the price of each unit in the tier if the charge model is tiered/volume pricing.

starting_unit_in_decimal

optional, string, max chars=33
The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal of the next lower tier. Returned only when the line_items.pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.

ending_unit_in_decimal

optional, string, max chars=33
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal of the next higher tier. Returned only when the line_items.pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.

quantity_used_in_decimal

optional, string, max chars=33
The decimal representation of the quantity purchased from this tier. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.

unit_amount_in_decimal

optional, string, max chars=40
The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for line_item. The value is in major units of the currency. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.

line_item_discounts
Show attributes[+]

optional, list of line_item_discount
The list of discount(s) applied for each line item of this invoice.

Line item discount attributes

line_item_id

string, max chars=50
The unique id of the line item that this deduction is for.

discount_type

enumerated string
The type of deduction and the amount to which it is applied.

Possible values are

item_level_couponThe deduction is due to a coupon applied to a line item of the invoice. The coupon id is available as entity_id.document_level_couponThe deduction is due to a coupon applied to the invoice sub_total. The coupon id is available as entity_id.promotional_creditsThe deduction is due to a promotional credit applied to the invoice. The entity_id is null in this case.prorated_creditsThe deduction is due to a legacy adjustment credit applied to the invoice. The entity_id is null in this case. The legacy credits feature is superseded by adjustment_credit_notes.

coupon_id

optional, string, max chars=50
When the deduction is due to a coupon, then this is the id of the coupon.

discount_amount

in cents, min=0
The amount deducted. The format of this value depends on the kind of currency.

reference_invoice_id

string, max chars=50
The reference invoice id

type

enumerated string
Credit note type

Possible values are

adjustmentAdjustment Credit NoterefundableRefundable Credit Note

price_type

enumerated string, default=tax_exclusive
The price type of this credit note.

Possible values are

tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.

currency_code

string, max chars=3
The currency code (ISO 4217 format) of the credit note.

sub_total

in cents, min=0
Invoice sub-total in cents.

total

in cents, min=0
Credit note total in cents.

amount_allocated

in cents, min=0
Allocated credits in cents.

amount_available

in cents, min=0
Remaining credits in cents

round_off_amount

customer_id

optional, string, max chars=100
A unique identifier for the customer this credit note belongs to

line_items
Show attributes[+]

optional, list of line_item
The list of items in this estimate

Line item attributes

id

optional, string, max chars=40
Uniquely identifies a line_item

subscription_id

optional, string, max chars=50
A unique identifier for the subscription this line item belongs to.

date_from

timestamp(UTC) in seconds
Start date of this line item.

date_to

timestamp(UTC) in seconds
End date of this line item.

unit_amount

in cents
Unit amount of the line item.

quantity

optional, integer, default=1
Quantity of the recurring item which is represented by this line item.

amount

optional, in cents
Total amount of this line item. Typically equals to unit amount x quantity

pricing_model

optional, enumerated string
The pricing scheme for this item.

Possible values are

is_taxed

boolean, default=false
Specifies whether this line item is taxed or not

tax_amount

optional, in cents, default=0, min=0
The tax amount charged for this item

tax_rate

optional, double, min=0.0, max=100.0
Rate of tax used to calculate tax for this lineitem

unit_amount_in_decimal

quantity_in_decimal

optional, string, max chars=33
The decimal representation of the quantity of this line_item. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.

amount_in_decimal

discount_amount

optional, in cents, min=0
Total discounts for this line

item_level_discount_amount

optional, in cents, min=0
Line Item-level discounts for this line.

reference_line_item_id

optional, string, max chars=40
Invoice Reference Line Item ID

description

string, max chars=250
Detailed description about this line item.

entity_description

optional, string, max chars=500
Detailed description about this item.

entity_type

enumerated string
Specifies the modelled entity this line item is based on.

Possible values are

tax_exempt_reason

optional, enumerated string
The reason due to which the line item price/amount is exempted from tax.

Possible values are

Show all values[+]

entity_id

optional, string, max chars=100
The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type

customer_id

optional, string, max chars=100
A unique identifier for the customer this line item belongs to

discounts
Show attributes[+]

optional, list of discount
The list of discounts applied to this estimate

Discount attributes

amount

in cents, min=0
The amount deducted. The format of this value depends on the kind of currency.

description

optional, string, max chars=250
Description for this deduction.

line_item_id

optional, string, max chars=40
The unique id of the line item that this deduction is for. Is required when discounts[entity_type] is item_level_coupon or document_level_coupon.

entity_type

enumerated string
The type of deduction and the amount to which it is applied.

Possible values are

entity_id

optional, string, max chars=100
When the deduction is due to a coupon, then this is the id of the coupon.

coupon_set_code

optional, string, max chars=50
The coupon code, if applicable, used to provide the discount. The coupon.id is available in entity_id.

taxes
Show attributes[+]

optional, list of tax
The list of taxes applied to this estimate

Tax attributes

name

string, max chars=100
The name of the tax applied. E.g. GST.

amount

in cents, min=0
The tax amount.

description

optional, string, max chars=250
Description of the tax item.

line_item_taxes
Show attributes[+]

optional, list of line_item_tax
The list of taxes applied on line items

Line item tax attributes

line_item_id

optional, string, max chars=40
The unique reference id of the line item for which the tax is applicable

tax_name

string, max chars=100
The name of the tax applied

tax_rate

double, default=0.0, min=0.0, max=100.0
The rate of tax used to calculate tax amount

is_partial_tax_applied

optional, boolean
Indicates if tax is applied only on a portion of the line item amount.

is_non_compliance_tax

optional, boolean
Indicates the non-compliance tax that should not be reported to the jurisdiction.

taxable_amount

in cents, min=0
Indicates the actual portion of the line item amount that is taxable.

tax_amount

in cents, min=0
The tax amount

tax_juris_type

optional, enumerated string
The type of tax jurisdiction

Possible values are

tax_juris_name

optional, string, max chars=250
The name of the tax jurisdiction

tax_juris_code

optional, string, max chars=250
The tax jurisdiction code

tax_amount_in_local_currency

optional, in cents, min=0
Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.

local_currency_code

optional, string, max chars=3
The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.

line_item_discounts
Show attributes[+]

optional, list of line_item_discount
The list of discount(s) applied for each line item of this invoice.

Line item discount attributes

line_item_id

string, max chars=50
The unique id of the line item that this deduction is for.

discount_type

enumerated string
The type of deduction and the amount to which it is applied.

Possible values are

coupon_id

optional, string, max chars=50
When the deduction is due to a coupon, then this is the id of the coupon.

discount_amount

in cents, min=0
The amount deducted. The format of this value depends on the kind of currency.

line_item_tiers
Show attributes[+]

optional, list of line_item_tier
The list of tiers applicable for this line item

Line item tier attributes

line_item_id

optional, string, max chars=40
Uniquely identifies a line_item

starting_unit

integer, min=0
The lower limit of a range of units for the tier

ending_unit

optional, integer
The upper limit of a range of units for the tier

quantity_used

integer, min=0
The number of units purchased in a range.

unit_amount

in cents, min=0
The price of the tier if the charge model is a stairtstep pricing , or the price of each unit in the tier if the charge model is tiered/volume pricing.

starting_unit_in_decimal

ending_unit_in_decimal

quantity_used_in_decimal

optional, string, max chars=33
The decimal representation of the quantity purchased from this tier. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.

unit_amount_in_decimal

id

optional, string, max chars=40
Uniquely identifies an unbilled charge.

customer_id

optional, string, max chars=50
A unique identifier for the customer being charged.

subscription_id

optional, string, max chars=50
A unique identifier for the subscription this charge belongs to.

date_from

optional, timestamp(UTC) in seconds
Start date of this charge.

date_to

optional, timestamp(UTC) in seconds
End date of this charge.

unit_amount

optional, in cents, min=0
Unit amount of the charge item.

pricing_model

optional, enumerated string
The pricing scheme for this line item.

Possible values are

quantity

optional, integer, min=0
Quantity of the item which is represented by this charge.

amount

optional, in cents, min=0
Total amount of this charge. Typically equals to unit amount x quantity.

currency_code

string, max chars=3
The currency code (ISO 4217 format) for the charge.

discount_amount

optional, in cents, min=0
Total discounts for this charge.

description

optional, string, max chars=250
Detailed description about this charge.

entity_type

enumerated string
Specifies the modelled entity this line item is based on.

Possible values are

entity_id

optional, string, max chars=100
The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.

is_voided

boolean, default=false
Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.

voided_at

optional, timestamp(UTC) in seconds
Timestamp indicating the date and time this charge got voided.

unit_amount_in_decimal

optional, string, max chars=39
The decimal representation of the amount for the charge, in major units of the currency. Typically equals to unit_amount_in_decimal x quantity_in_decimal. Returned when multi-decimal pricing is enabled.

quantity_in_decimal

optional, string, max chars=33
The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and multi-decimal pricing is enabled.

amount_in_decimal

optional, string, max chars=39
The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and multi-decimal pricing is enabled.

updated_at

timestamp(UTC) in seconds
Timestamp indicating when the unbilled charge was last updated

is_advance_charge

optional, boolean, default=false
The value of this parameter will be true if it is a recurring unbilled charge for a future term.

deleted

boolean
Indicates that this resource has been deleted.

tiers
Show attributes[+]

optional, list of line_item_tier
The list of tiers applicable for this line item

Tier attributes

line_item_id

optional, string, max chars=40
Uniquely identifies a line_item

starting_unit

integer, min=0
The lower limit of a range of units for the tier

ending_unit

optional, integer
The upper limit of a range of units for the tier

quantity_used

integer, min=0
The number of units purchased in a range.

unit_amount

in cents, min=0
The price of the tier if the charge model is a stairtstep pricing , or the price of each unit in the tier if the charge model is tiered/volume pricing.

starting_unit_in_decimal

ending_unit_in_decimal

quantity_used_in_decimal

optional, string, max chars=33
The decimal representation of the quantity purchased from this tier. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.

unit_amount_in_decimal

Generates an estimate for the 'create subscription' operation. This is similar to the Create Subscription API but no subscription will be created, only an estimate for this operation is created.

In the response,

estimate.subscription_estimate has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.
estimate.invoice_estimate has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation.
estimate.next_invoice_estimate has details of the invoice that will be generated on the next billing date of this subscription. This will be present only if no immediate invoice is generated during this operation and this subscription has next billing.

If the subscription is created in trial/future states, estimate.invoice_estimate will not be present as no immediate invoice would be generated. However, estimate.next_invoice_estimate will be returned which is a preview of the invoice that would be generated at a later date when the subscription becomes 'active'.
estimate.unbilled_charge_estimates has details of the unbilled charges. This is returned only if invoice_immediately is set as false. But this is not applicable for the ‘Subscription renewal estimate’ operation.

Tip
Set the customer[taxability] attribute as true and provide any other necessary parameters to compute taxes. Otherwise tax is exempted for the estimate.

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505710,
    "invoice_estimate": {
        "amount_due": 895,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWl2E82aS",
        "date": 1517505710,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 895,
                "customer_id": "__test__KyVnHhSBWl2E82aS",
                "date_from": 1517505710,
                "date_to": 1519924910,
                "description": "No Trial",
                "discount_amount": 0,
                "entity_id": "no_trial",
                "entity_type": "plan",
                "id": "li___test__KyVnHhSBWl2Eq2aU",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 895
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 895,
        "taxes": [],
        "total": 895
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1519924910,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/estimates/create_subscription

billing_cycles

optional, integer, min=0
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.

mandatory_addons_to_remove[0..n]

optional, list of string
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.

terms_to_charge

optional, integer, min=1
The number of subscription billing cycles (including the first one) to invoice in advance.

billing_alignment_mode

optional, enumerated string
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.

Possible values are

immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.

coupon_ids[0..n]

optional, list of string
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.

invoice_immediately

optional, boolean
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.

Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.

invoice_date

optional, timestamp(UTC) in seconds
The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date. taxes and line_item_taxes are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.

client_profile_id

optional, string, max chars=50
Indicates the Client profile id for the customer. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

subscription

Parameters for subscription
pass parameters as subscription[<param name>]

subscription[id]

optional, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

subscription[plan_id]

required, string, max chars=100
Identifier of the plan for this subscription

subscription[plan_quantity]

optional, integer, default=1, min=1
Plan quantity for this subscription

subscription[plan_quantity_in_decimal]

optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.

subscription[plan_unit_price]

optional, in cents, min=0
Amount that will override the Plan's default price. The unit depends on the type of currency.

subscription[plan_unit_price_in_decimal]

optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.

subscription[setup_fee]

optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.

subscription[trial_end]

optional, timestamp(UTC) in seconds
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.

subscription[start_date]

optional, timestamp(UTC) in seconds
The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

Backdating is enabled for subscription creation operations.
The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, start_date cannot be earlier than 14th February.

subscription[offline_payment_method]

optional, enumerated string
The preferred offline payment method for the subscription.

Possible values are

no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA CreditboletoBoleto

subscription[free_period]

optional, integer, min=1
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.

subscription[free_period_unit]

optional, enumerated string
The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.

Possible values are

dayCharge based on day(s)weekCharge based on week(s)monthCharge based on month(s)yearCharge based on year(s)

subscription[contract_term_billing_cycle_on_renewal]

optional, integer, min=1, max=100
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.

subscription[trial_end_action]

Possible values are

billing_address

Parameters for billing_address
pass parameters as billing_address[<param name>]

billing_address[line1]

optional, string, max chars=150
Address line 1

billing_address[line2]

optional, string, max chars=150
Address line 2

billing_address[line3]

optional, string, max chars=150
Address line 3

billing_address[city]

optional, string, max chars=50
The name of the city.

billing_address[state_code]

billing_address[zip]

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

billing_address[country]

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

billing_address[validation_status]

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[line1]

optional, string, max chars=150
Address line 1

shipping_address[line2]

optional, string, max chars=150
Address line 2

shipping_address[line3]

optional, string, max chars=150
Address line 3

shipping_address[city]

optional, string, max chars=50
The name of the city.

shipping_address[state_code]

shipping_address[zip]

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

shipping_address[country]

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

shipping_address[validation_status]

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

customer

Parameters for customer
pass parameters as customer[<param name>]

customer[vat_number]

optional, string, max chars=20
VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.

customer[vat_number_prefix]

optional, string, max chars=10
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with billing_address country as XI (which is United Kingdom - Northern Ireland).

When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting billing_address country as XI. That’s the code for United Kingdom - Northern Ireland. The first two characters of the VAT number in such a case is XI by default. However, if the VAT number was registered in UK, the value should be GB. Set vat_number_prefix to GB for such cases.

customer[registered_for_gst]

optional, boolean
Confirms that a customer is registered under GST. If set to true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.

customer[taxability]

optional, enumerated string, default=taxable
Specifies if the customer is liable for tax

Possible values are

taxableComputes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.exempt

Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.

customer[entity_code]

optional, enumerated string
The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's AvaTax for Sales integration.

Possible values are

aFederal governmentbState governmentcTribe/Status Indian/Indian BanddForeign diplomat

eCharitable or benevolent organizationfReligious organizationgResalehCommercial agricultural productioniIndustrial production/manufacturerjDirect pay permitkDirect maillOther or custommEducational organizationnLocal governmentpCommercial aquacultureqCommercial FisheryrNon-residentmed1US Medical Device Excise Tax with exempt sales taxmed2US Medical Device Excise Tax with taxable sales tax

Show all values[+]

customer[exempt_number]

optional, string, max chars=100
Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's AvaTax for Sales integration.

customer[exemption_details]

optional, jsonarray
Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
To know more about what values you need to provide, refer to this Avalara’s API document.

customer[customer_type]

optional, enumerated string
Indicates the type of the customer. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

Possible values are

residentialWhen the purchase is made by a customer for home usebusinessWhen the purchase is made at a place of businesssenior_citizenWhen the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaksindustrialWhen the purchase is made by an industrial business

contract_term

Parameters for contract_term
pass parameters as contract_term[<param name>]

contract_term[action_at_term_end]

optional, enumerated string, default=cancel
Action to be taken when the contract term completes.

Possible values are

renew

Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.

The action_at_term_end for the new contract term is set to renew.

evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.

contract_term[cancellation_cutoff_period]

optional, integer, default=0
The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.

addons[quantity][0..n]

optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.

addons[unit_price][0..n]

optional, in cents, min=0

The price or per-unit-price of the addon. The value depends on the type of currency.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

The unit_price provided is $10
The addon billing period is 1 month.
The plan billing period is 3 months.
The addon is only billed for $10 on each subscription renewal.

addons[unit_price_in_decimal][0..n]

optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.

addons[billing_cycles][0..n]

optional, integer, min=1
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.

addons[trial_end][0..n]

optional, timestamp(UTC) in seconds
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support)

event_based_addons

Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]

event_based_addons[id][0..n]

optional, string, max chars=100
A unique 'id' used to identify the addon.

event_based_addons[quantity][0..n]

optional, integer, min=0
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

event_based_addons[unit_price][0..n]

optional, in cents, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.

event_based_addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.

event_based_addons[unit_price_in_decimal][0..n]

event_based_addons[service_period_in_days][0..n]

optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.

event_based_addons[on_event][0..n]

optional, enumerated string
Event on which this addon will be charged.

Possible values are

subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.

event_based_addons[charge_once][0..n]

optional, boolean, default=true
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.

event_based_addons[charge_on][0..n]

optional, enumerated string
Indicates when the non-recurring addon will be charged.

Possible values are

immediatelyCharges for the addon will be applied immediately.on_eventCharge for the addon will be applied on the occurrence of a specified event.

estimate

always returned
Resource object representing estimate

Create a subscription for the existing estimate of a customer.

Sample Request

curl  https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWl2XD2aV/create_subscription_estimate \
     -G  \
     -u {site_api_key}:\

copy

curl  https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWl2XD2aV/create_subscription_estimate \
     -G  \
     -u {site_api_key}:\

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505711,
    "invoice_estimate": {
        "amount_due": 895,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWl2XD2aV",
        "date": 1517505711,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 895,
                "customer_id": "__test__KyVnHhSBWl2XD2aV",
                "date_from": 1517505711,
                "date_to": 1519924911,
                "description": "No Trial",
                "discount_amount": 0,
                "entity_id": "no_trial",
                "entity_type": "plan",
                "id": "li___test__KyVnHhSBWl2Yy2aZ",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 895
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 895,
        "taxes": [],
        "total": 895
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1519924911,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format GET

https://{site}.chargebee.com/api/v2/customers/{customer_id}/create_subscription_estimate

use_existing_balances

optional, boolean, default=true
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.

invoice_immediately

Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.

billing_cycles

optional, integer, min=0
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.

mandatory_addons_to_remove[0..n]

optional, list of string
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.

terms_to_charge

optional, integer, min=1
The number of subscription billing cycles (including the first one) to invoice in advance.

billing_alignment_mode

optional, enumerated string
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.

Possible values are

invoice_date

coupon_ids[0..n]

optional, list of string
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.

subscription

Parameters for subscription
pass parameters as subscription[<param name>]

subscription[id]

optional, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

subscription[plan_id]

required, string, max chars=100
Identifier of the plan for this subscription

subscription[plan_quantity]

optional, integer, default=1, min=1
Plan quantity for this subscription

subscription[plan_quantity_in_decimal]

optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.

subscription[plan_unit_price]

optional, in cents, min=0
Amount that will override the Plan's default price. The unit depends on the type of currency.

subscription[plan_unit_price_in_decimal]

subscription[setup_fee]

optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.

subscription[trial_end]

subscription[start_date]

Backdating is enabled for subscription creation operations.
The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, start_date cannot be earlier than 14th February.

subscription[offline_payment_method]

optional, enumerated string
The preferred offline payment method for the subscription.

Possible values are

no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA CreditboletoBoleto

subscription[free_period]

optional, integer, min=1
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.

subscription[free_period_unit]

optional, enumerated string
The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.

Possible values are

dayCharge based on day(s)weekCharge based on week(s)monthCharge based on month(s)yearCharge based on year(s)

subscription[contract_term_billing_cycle_on_renewal]

subscription[trial_end_action]

Possible values are

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[line1]

optional, string, max chars=150
Address line 1

shipping_address[line2]

optional, string, max chars=150
Address line 2

shipping_address[line3]

optional, string, max chars=150
Address line 3

shipping_address[city]

optional, string, max chars=50
The name of the city.

shipping_address[state_code]

shipping_address[zip]

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

shipping_address[country]

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

shipping_address[validation_status]

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

contract_term

Parameters for contract_term
pass parameters as contract_term[<param name>]

contract_term[action_at_term_end]

optional, enumerated string, default=cancel
Action to be taken when the contract term completes.

Possible values are

renew

Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.

The action_at_term_end for the new contract term is set to renew.

evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.

contract_term[cancellation_cutoff_period]

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.

addons[quantity][0..n]

optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.

addons[unit_price][0..n]

optional, in cents, min=0

The price or per-unit-price of the addon. The value depends on the type of currency.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

The unit_price provided is $10
The addon billing period is 1 month.
The plan billing period is 3 months.
The addon is only billed for $10 on each subscription renewal.

addons[unit_price_in_decimal][0..n]

addons[billing_cycles][0..n]

addons[trial_end][0..n]

event_based_addons

Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]

event_based_addons[id][0..n]

optional, string, max chars=100
A unique 'id' used to identify the addon.

event_based_addons[quantity][0..n]

optional, integer, min=0
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

event_based_addons[unit_price][0..n]

optional, in cents, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.

event_based_addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.

event_based_addons[unit_price_in_decimal][0..n]

event_based_addons[service_period_in_days][0..n]

optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.

event_based_addons[on_event][0..n]

optional, enumerated string
Event on which this addon will be charged.

Possible values are

event_based_addons[charge_once][0..n]

optional, boolean, default=true
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.

event_based_addons[charge_on][0..n]

optional, enumerated string
Indicates when the non-recurring addon will be charged.

Possible values are

immediatelyCharges for the addon will be applied immediately.on_eventCharge for the addon will be applied on the occurrence of a specified event.

estimate

always returned
Resource object representing 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, only an estimate will be created.

In the response,

subscription_estimate: The details of the changed subscription such as status, next billing date, and so on.
invoice_estimate:The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:
- end_of_term parameter is true
- prorate parameter is false
- No changes are made to subscription or addons.
- For changes such as quantity downgrades.
next_invoice_estimate:The details of the invoice to be generated later (if any) on the occasion that no immediate invoice has been generated.
credit_note_estimates:The list of credit notes (if any) generated during this operation.
unbilled_charge_estimates: The details of charges that have not been invoiced. This is returned only if the invoice_immediately parameter is set to false.

Note: If you have configured EU VAT or Customized taxes, you need to specify the applicable parameters for calculating taxes - billing_address[], shipping_address[], customer[vat_number], customer[taxability] etc. Otherwise tax calculation will be ignored.

Sample Request

curl  https://{site}.chargebee.com/api/v2/estimates/update_subscription \
     -u {site_api_key}:\
     -d subscription[id]="__test__KyVnHhSBWl3M42aj" \
     -d subscription[plan_id]="plan1" \
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US"

copy

curl  https://{site}.chargebee.com/api/v2/estimates/update_subscription \
     -u {site_api_key}:\
     -d subscription[id]="__test__KyVnHhSBWl3M42aj" \
     -d subscription[plan_id]="plan1" \
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505714,
    "credit_note_estimates": [
        {
            "amount_allocated": 895,
            "amount_available": 0,
            "currency_code": "USD",
            "customer_id": "__test__KyVnHhSBWl3M42aj",
            "line_item_discounts": [],
            "line_item_taxes": [],
            "line_items": [
                {
                    "amount": 895,
                    "customer_id": "__test__KyVnHhSBWl3M42aj",
                    "date_from": 1517505714,
                    "date_to": 1519924914,
                    "description": "No Trial - Prorated Credits for 01-Feb-2018 - 01-Mar-2018",
                    "discount_amount": 0,
                    "entity_id": "no_trial",
                    "entity_type": "plan",
                    "id": "li___test__KyVnHhSBWl3TH2at",
                    "is_taxed": false,
                    "item_level_discount_amount": 0,
                    "object": "line_item",
                    "pricing_model": "per_unit",
                    "quantity": 1,
                    "subscription_id": "__test__KyVnHhSBWl3M42aj",
                    "tax_amount": 0,
                    "unit_amount": 895
                },
                {..}
            ],
            "object": "credit_note_estimate",
            "price_type": "tax_exclusive",
            "reference_invoice_id": "__demo_inv__6",
            "round_off_amount": 0,
            "sub_total": 895,
            "taxes": [],
            "total": 895,
            "type": "adjustment"
        },
        {..}
    ],
    "invoice_estimate": {
        "amount_due": 1500,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWl3M42aj",
        "date": 1517505714,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1500,
                "customer_id": "__test__KyVnHhSBWl3M42aj",
                "date_from": 1517505714,
                "date_to": 1519924914,
                "description": "Plan1 - Prorated Charges",
                "discount_amount": 0,
                "entity_id": "plan1",
                "entity_type": "plan",
                "id": "li___test__KyVnHhSBWl3T72ar",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "subscription_id": "__test__KyVnHhSBWl3M42aj",
                "tax_amount": 0,
                "unit_amount": 1500
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 1500,
        "taxes": [],
        "total": 1500
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnHhSBWl3M42aj",
        "next_billing_at": 1519924914,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/estimates/update_subscription

replace_addon_list

optional, boolean
Should be true if the existing addons should be replaced with the ones that are being passed.

mandatory_addons_to_remove[0..n]

optional, list of string
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.

invoice_date

optional, timestamp(UTC) in seconds
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is set to true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:

invoice_date must be in the past.
invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
It is not earlier than changes_scheduled_at, reactivate_from, or trial_end.
invoice_immediately is true.

billing_cycles

optional, integer, min=0
The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.

terms_to_charge

optional, integer, min=1
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset.

reactivate_from

optional, timestamp(UTC) in seconds
If the subscription status is cancelled and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
Note: It is recommended not to pass this parameter along with changed_scheduled_at. reactivate_from can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

Backdating must be enabled for subscription reactivation operations.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
The date is on or after the last date/time any of the product catalog items of the subscription were changed.
The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February.

billing_alignment_mode

optional, enumerated string
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.

Possible values are

coupon_ids[0..n]

optional, list of string
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.

replace_coupon_list

optional, boolean
If true then the existing coupon_ids list for the subscription is replaced by the one provided. If false then the provided list gets added to the existing coupon_ids.

prorate

optional, boolean

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 prorate set to false and
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.

end_of_term

optional, boolean
Set this to true if you want the update to be applied at the end of the current subscription billing cycle.

force_term_reset

optional, boolean, default=false
Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as true will have the subscription reset its term to the current date (provided end_of_term is false).
Note: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.

reactivate

optional, boolean
Applicable only for cancelled subscriptions. When passed as true, the canceled subscription is activated; otherwise subscription changes are made without changing its status. If not passed, subscription will be activated only if subscription_items is passed.

include_delayed_charges

optional, boolean, default=false
If true, all the unbilled charges will be included for the invoice estimate.

use_existing_balances

invoice_immediately

Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.

subscription

Parameters for subscription
pass parameters as subscription[<param name>]

subscription[id]

required, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

subscription[plan_id]

optional, string, max chars=100
Identifier of the plan for this subscription

subscription[plan_quantity]

optional, integer, min=1
Represents the plan quantity for this subscription.

subscription[plan_unit_price]

optional, in cents, min=0
Amount that will override the Plan's default price. The unit depends on the type of currency.

subscription[setup_fee]

optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.

subscription[plan_quantity_in_decimal]

optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.

subscription[plan_unit_price_in_decimal]

subscription[start_date]

optional, timestamp(UTC) in seconds
The new start date of a future subscription. Applicable only for future subscriptions.

subscription[trial_end]

optional, timestamp(UTC) in seconds
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status is future, in_trial, or cancelled. Also, the value must not be earlier than changes_scheduled_at or start_date. Note: This parameter can be backdated (set to a value in the past) only when the subscription is in cancelled or in_trial status. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end is backdated, the subscription immediately goes into active or non_renewing status.

subscription[auto_collection]

optional, enumerated string
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.

Possible values are

onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.

subscription[offline_payment_method]

optional, enumerated string
The preferred offline payment method for the subscription.

Possible values are

no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA CreditboletoBoleto

subscription[free_period]

optional, integer, min=1
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.

subscription[free_period_unit]

optional, enumerated string
The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.

Possible values are

dayCharge based on day(s)weekCharge based on week(s)monthCharge based on month(s)yearCharge based on year(s)

subscription[trial_end_action]

Possible values are

billing_address

Parameters for billing_address
pass parameters as billing_address[<param name>]

billing_address[line1]

optional, string, max chars=150
Address line 1

billing_address[line2]

optional, string, max chars=150
Address line 2

billing_address[line3]

optional, string, max chars=150
Address line 3

billing_address[city]

optional, string, max chars=50
The name of the city.

billing_address[state_code]

billing_address[zip]

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

billing_address[country]

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

billing_address[validation_status]

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[line1]

optional, string, max chars=150
Address line 1

shipping_address[line2]

optional, string, max chars=150
Address line 2

shipping_address[line3]

optional, string, max chars=150
Address line 3

shipping_address[city]

optional, string, max chars=50
The name of the city.

shipping_address[state_code]

shipping_address[zip]

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

shipping_address[country]

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

shipping_address[validation_status]

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

customer

Parameters for customer
pass parameters as customer[<param name>]

customer[vat_number]

customer[vat_number_prefix]

customer[registered_for_gst]

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.

addons[quantity][0..n]

optional, integer, min=1
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

addons[unit_price][0..n]

optional, in cents, min=0

The price or per-unit-price of the addon. The value depends on the type of currency.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

The unit_price provided is $10
The addon billing period is 1 month.
The plan billing period is 3 months.
The addon is only billed for $10 on each subscription renewal.

addons[billing_cycles][0..n]

addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.

addons[unit_price_in_decimal][0..n]

addons[trial_end][0..n]

optional, timestamp(UTC) in seconds
The time at which the trial ends for the addon. To update this value, redo the complete addon set using replace_addon_list. (Addon trial periods must be enabled by Chargebee Support.)

event_based_addons

Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]

event_based_addons[id][0..n]

optional, string, max chars=100
A unique 'id' used to identify the addon.

event_based_addons[quantity][0..n]

optional, integer, min=0
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

event_based_addons[unit_price][0..n]

optional, in cents, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.

event_based_addons[service_period_in_days][0..n]

optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.

event_based_addons[charge_on][0..n]

optional, enumerated string
Indicates when the non-recurring addon will be charged.

Possible values are

immediatelyCharges for the addon will be applied immediately.on_eventCharge for the addon will be applied on the occurrence of a specified event.

event_based_addons[on_event][0..n]

optional, enumerated string
Event on which this addon will be charged.

Possible values are

event_based_addons[charge_once][0..n]

optional, boolean
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.

event_based_addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.

event_based_addons[unit_price_in_decimal][0..n]

estimate

always returned
Resource object representing 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.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkzpS2Zo/renewal_estimate \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkzpS2Zo/renewal_estimate \
     -u {site_api_key}:

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505701,
    "invoice_estimate": {
        "amount_due": 895,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWkzpS2Zo",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 895,
                "customer_id": "__test__KyVnHhSBWkzpS2Zo",
                "date_from": 1519924901,
                "date_to": 1522603301,
                "description": "No Trial",
                "discount_amount": 0,
                "entity_id": "no_trial",
                "entity_type": "plan",
                "id": "li___test__KyVnHhSBWkzv72Zv",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "subscription_id": "__test__KyVnHhSBWkzpS2Zo",
                "tax_amount": 0,
                "unit_amount": 895
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 895,
        "taxes": [],
        "total": 895
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnHhSBWkzpS2Zo",
        "next_billing_at": 1519924901,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format GET

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/renewal_estimate

include_delayed_charges

optional, boolean, default=true
If true, all the unbilled charges will be included for the invoice estimate.

use_existing_balances

ignore_scheduled_cancellation

optional, boolean, default=false
if true, ignores scheduled cancellation for non renewing subscription.

ignore_scheduled_changes

optional, boolean, default=false
If true, ignores all recurring charges scheduled during renewal.

estimate

always returned
Resource object representing estimate

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

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkjcSAl6gBw1/advance_invoice_estimate \
     -u {site_api_key}:\
     -d invoice_immediately="false" \
     -d terms_to_charge=3

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkjcSAl6gBw1/advance_invoice_estimate \
     -u {site_api_key}:\
     -d invoice_immediately="false" \
     -d terms_to_charge=3

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517492806,
    "object": "estimate",
    "unbilled_charge_estimates": [
        {
            "amount": 895,
            "currency_code": "USD",
            "customer_id": "__test__KyVkjcSAl6gBw1",
            "date_from": 1519912004,
            "date_to": 1522590404,
            "deleted": false,
            "description": "No Trial",
            "discount_amount": 0,
            "entity_id": "no_trial",
            "entity_type": "plan",
            "id": "li___test__KyVkjcSAl6gcKF",
            "is_voided": false,
            "object": "unbilled_charge",
            "pricing_model": "per_unit",
            "quantity": 1,
            "subscription_id": "__test__KyVkjcSAl6gBw1",
            "unit_amount": 895
        },
        {..}
    ]
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/advance_invoice_estimate

terms_to_charge

optional, integer, default=1, min=1

For schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_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.

invoice_immediately

optional, boolean
Whether the charge should be invoiced immediately or added to unbilled_charges. Applicable only when schedule_type is immediate.

schedule_type

optional, enumerated string
The type of advance invoice or advance invoicing schedule.

Possible values are

immediateCharge immediately for the number of billing cycles specified by terms_to_charge.specific_datesCharge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured.fixed_intervalsCharge 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.

fixed_interval_schedule

Parameters for fixed_interval_schedule
pass parameters as fixed_interval_schedule[<param name>]

fixed_interval_schedule[number_of_occurrences]

optional, integer, min=1
The number of advance invoices to generate. 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. This parameter is applicable only when fixed_interval_schedule[end_schedule_on] = after_number_of_intervals

fixed_interval_schedule[days_before_renewal]

optional, integer, min=1
The number of days before each interval that advance invoices are generated.

fixed_interval_schedule[end_schedule_on]

optional, enumerated string
Specifies when the schedule should end.

Possible values are

after_number_of_intervalsAdvance invoices are generated a specified number of timesspecific_dateEnd the advance invoicing schedule on a specific date.subscription_endAdvance invoices are generated for as long as the subscription is active.

fixed_interval_schedule[end_date]

optional, timestamp(UTC) in seconds
The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when fixed_interval_schedule[end_schedule_on] = specific_date.

specific_dates_schedule

Parameters for specific_dates_schedule. Multiple specific_dates_schedule can be passed by specifying unique indices.
pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]

specific_dates_schedule[terms_to_charge][0..n]

optional, integer
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type is specific_dates.

specific_dates_schedule[date][0..n]

optional, timestamp(UTC) in seconds
The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type is specific_dates.

estimate

always returned
Resource object representing estimate

Regenerates the invoice for the current term of the subscription. The subscription must have status as active or non_renewing. This operation is not allowed when any of the following conditions hold true for the subscription:

An invoice exists for the current term and its status is not voided.
There are unbilled charges for the current term.
The subscription has an advance invoice.

Response

Returns an estimate object with one of the following components depending on the value of invoice_immediately.

If the value is true: an invoice_estimate object that corresponds to the regenerated invoice.
If the value is false: a list of unbilled_charge_estimate objects corresponding to all the unbilled charges created for the current term of the subscription.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnOuSHufvfo16/regenerate_invoice_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d invoice_immediately="true"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnOuSHufvfo16/regenerate_invoice_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d invoice_immediately="true"

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnOuSHufpzqv/regenerate_invoice_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d invoice_immediately="false" \
     -d date_from=1518344700 \
     -d date_to=1519381500 \
     -d prorate="true"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517480722,
    "invoice_estimate": {
        "amount_due": 895,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVnOuSHufvfo16",
        "date": 1517480722,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 895,
                "customer_id": "__test__KyVnOuSHufvfo16",
                "date_from": 1517480722,
                "date_to": 1519899922,
                "description": "No Trial",
                "discount_amount": 0,
                "entity_id": "no_trial",
                "entity_type": "plan",
                "id": "li___test__KyVnOuSHufvn81H",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "subscription_id": "__test__KyVnOuSHufvfo16",
                "tax_amount": 0,
                "unit_amount": 895
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 895,
        "taxes": [],
        "total": 895
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnOuSHufvfo16",
        "next_billing_at": 1519899922,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

{"estimate": {
    "created_at": 1517480701,
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnOuSHufpzqv",
        "next_billing_at": 1519899900,
        "object": "subscription_estimate",
        "status": "active"
    },
    "unbilled_charge_estimates": [
        {
            "amount": 384,
            "currency_code": "USD",
            "customer_id": "__test__KyVnOuSHufpzqv",
            "date_from": 1518344700,
            "date_to": 1519381500,
            "deleted": false,
            "description": "No Trial - Prorated Charges",
            "discount_amount": 0,
            "entity_id": "no_trial",
            "entity_type": "plan",
            "id": "li___test__KyVnOuSHufqEa15",
            "is_voided": false,
            "object": "unbilled_charge",
            "pricing_model": "per_unit",
            "quantity": 1,
            "subscription_id": "__test__KyVnOuSHufpzqv",
            "unit_amount": 384
        },
        {..}
    ]
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/regenerate_invoice_estimate

date_from

optional, timestamp(UTC) in seconds
The start date of the period being invoiced. The default value is current_term_start.

date_to

optional, timestamp(UTC) in seconds
The end date of the period being invoiced. The default value is current_term_end.

prorate

optional, boolean
Whether the charges should be prorated according to the term specified by date_from and date_to. Should not be passed without date_from and date_to.

invoice_immediately

optional, boolean
Only applicable when Consolidated Invoicing is enabled for the customer. Set to false to leave the current term charge for the subscription as unbilled. Once you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges to invoice them.

estimate

always returned
Resource object representing estimate

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

curl  https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWl2pw2aa/upcoming_invoices_estimate \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWl2pw2aa/upcoming_invoices_estimate \
     -u {site_api_key}:

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505713,
    "invoice_estimates": [
        {
            "amount_due": 1790,
            "amount_paid": 0,
            "credits_applied": 0,
            "currency_code": "USD",
            "customer_id": "__test__KyVnHhSBWl2pw2aa",
            "date": 1517505713,
            "line_item_discounts": [],
            "line_item_taxes": [],
            "line_items": [
                {
                    "amount": 895,
                    "customer_id": "__test__KyVnHhSBWl2pw2aa",
                    "date_from": 1517505712,
                    "date_to": 1519924912,
                    "description": "No Trial",
                    "discount_amount": 0,
                    "entity_id": "no_trial",
                    "entity_type": "plan",
                    "id": "li___test__KyVnHhSBWl2rW2ac",
                    "is_taxed": false,
                    "item_level_discount_amount": 0,
                    "object": "line_item",
                    "pricing_model": "per_unit",
                    "quantity": 1,
                    "subscription_id": "__test__KyVnHhSBWl2pw2aa",
                    "tax_amount": 0,
                    "unit_amount": 895
                },
                {..}
            ],
            "object": "invoice_estimate",
            "price_type": "tax_exclusive",
            "recurring": true,
            "round_off_amount": 0,
            "sub_total": 1790,
            "taxes": [],
            "total": 1790
        },
        {..}
    ],
    "object": "estimate"
}}

URL Format GET

https://{site}.chargebee.com/api/v2/customers/{customer_id}/upcoming_invoices_estimate

estimate

always returned
Resource object representing estimate

Generates an estimate for the 'change term end' operation. This is similar to the Change term end API but the subscription’s term end will not be changed, only an estimate for this operation is created. This is applicable only for subscriptions in ‘in-trial’, ‘active’ and ‘non-renewing’ states.

In the response,

estimate.subscription_estimate has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.
estimate.invoice_estimate has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation. This will happen when
- prorate parameter is false, or
- invoice_immediately parameter is false, or
- subscription is in in-trial state
estimate.credit_note_estimates[] has details of the credit-notes that will get generated during this operation. This list will be empty if no credit-note gets generated during this operation.
estimate.unbilled_charge_estimates[] has details of the unbilled charges. This is returned only if invoice_immediately is set as false.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkzRq2Zh/change_term_end_estimate \
     -u {site_api_key}:\
     -d term_ends_at=1566697500

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkzRq2Zh/change_term_end_estimate \
     -u {site_api_key}:\
     -d term_ends_at=1566697500

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505699,
    "credit_note_estimates": [],
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnHhSBWkzRq2Zh",
        "next_billing_at": 1566697500,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/change_term_end_estimate

term_ends_at

required, timestamp(UTC) in seconds
The time at which the current term should end for this subscription.

prorate

optional, boolean
Applicable for active / non_renewing subscriptions. If specified as true prorated charges / credits will be added during this operation.

invoice_immediately

Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.

estimate

always returned
Resource object representing estimate

Generates an estimate for the 'cancel subscription' operation. This is similar to the Cancel a subscription API, but the subscription will not be cancelled. Only an estimate for this operation is created.

In the response,

estimate.subscription_estimate has the subscription details.
estimate.invoice_estimate has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation.
estimate.credit_note_estimates[] has details of the credit-notes that will get generated during this operation. This list will be empty if no credit-note gets generated during this operation.
estimate.unbilled_charge_estimates has details of the unbilled charges.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkz4Y2Za/cancel_subscription_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d end_of_term="true"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkz4Y2Za/cancel_subscription_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d end_of_term="true"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505698,
    "credit_note_estimates": [],
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnHhSBWkz4Y2Za",
        "object": "subscription_estimate",
        "status": "non_renewing"
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/cancel_subscription_estimate

end_of_term

optional, boolean, default=false
Set this to true if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status changes to non_renewing.

cancel_at

optional, timestamp(UTC) in seconds
Specify the date/time at which you want to cancel the subscription. This parameter should not be provided when end_of_term is passed as true. cancel_at can be set to a value in the past. This is called backdating. Use backdating when the subscription has been canceled already but its billing has been delayed. The following prerequisites must be met to allow backdating:

Backdating must be enabled for subscription cancellation.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription cancellation. This limit is typically the day of the month by which the accounting for the previous month must be closed.
The date is on or after current_term_start.
The date is on or after the last date/time any of the following changes were made:

Changes in the recurring items or their prices.
Addition of non-recurring items.

The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription’s plan is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February.

credit_option_for_current_term_charges

optional, enumerated string
For immediate cancellation (end_of_term = false), specify how to provide credits for current term charges. When not provided, the site default is considered.

Possible values are

noneNo credits notes are created.prorateProrated credits are issued.fullCredits are issues for the full value of the current term charges.

unbilled_charges_option

optional, enumerated string
For immediate cancellation (end_of_term = false), specify how to handle any unbilled charges. When not provided, the site default is considered.

Possible values are

invoiceAn invoice is generated immediately with the unbilled charges.deleteThe unbilled charges are deleted.

account_receivables_handling

optional, enumerated string
Applicable when the subscription has past due invoices. Specify this if you want to close the due invoices of the subscription. If specified as schedule_payment_collection/write_off, the due invoices of the subscription will be qualified for the selected operation after the remaining refundable credits and excess payments are applied. Note: The payment collection attempt will be asynchronous. Not applicable when 'end_of_term' is true.

Possible values are

no_actionNo action is taken.schedule_payment_collectionAn automatic charge for the due amount of the past invoices will be attempted on the payment method available, if customer's auto-collection property is ‘ON’.write_offThe amount due in the invoices will be written-off. Credit notes created due to write-off will not be sent in the response.

refundable_credits_handling

optional, enumerated string
Applicable when the customer has remaining refundable credits(issued against online payments). If specified as schedule_refund, the refund will be initiated for these credits after they are applied against the subscription’s past due invoices if any. Note: The refunds initiated will be asynchronous. Not applicable when 'end_of_term' is true.

Possible values are

no_actionNo action is taken. schedule_refundInitiates refund of the remaining credits.

contract_term_cancel_option

optional, enumerated string
Cancels the current contract term.

terminate_immediately immediately does the following:
- sets the contract term status to terminated.
- Cancels the subscription.
- Collects any termination fee.
end_of_contract_term Sets the contract_term[action_at_term_end] to cancel. In other words, the contract term is not renewed and the subscription is canceled at the end of the contract term.

Possible values are

terminate_immediatelyTerminate immediatelyend_of_contract_termEnd of contract term

invoice_date

optional, timestamp(UTC) in seconds
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:

invoice_date must be in the past.
invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
It is not earlier than cancel_at.

cancel_reason_code

optional, string, max chars=100
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive.

event_based_addons

Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]

event_based_addons[id][0..n]

optional, string, max chars=100
The unique id of the event-based addon that represents the termination fee.

event_based_addons[quantity][0..n]

optional, integer, min=0
The quantity associated with the termination fee. Applicable only when the addon for the termination charge is quantity-based.

event_based_addons[unit_price][0..n]

optional, in cents, min=0
The termination fee. In case it is quantity-based, this is the fee per unit.

event_based_addons[service_period_in_days][0..n]

optional, integer, min=1, max=730
The service period of the termination fee—expressed in days—starting from the current date.

estimate

always returned
Resource object representing estimate

This API provides an estimate of the details pertaining to the pause_subscription operation. It returns attributes such as pause_date and resume_date. This is similar to the Pause a subscription API with the exception that the subscription is not paused. Only an estimate for this operation is created.

In the response,

estimate.subscription_estimate has the subscription details.
estimate.invoice_estimate has details of the invoice that are generated immediately. This is not present if no immediate invoices are generated for this operation.
estimate.credit_note_estimates[] has details of the credit notes that are generated during this operation. This list is empty if no credit notes are generated.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWl1SO2aC/pause_subscription_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d pause_option="specific_date" \
     -d subscription[pause_date]=1566698400

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWl1SO2aC/pause_subscription_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d pause_option="specific_date" \
     -d subscription[pause_date]=1566698400

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505707,
    "credit_note_estimates": [],
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnHhSBWl1SO2aC",
        "next_billing_at": 1519924907,
        "object": "subscription_estimate",
        "pause_date": 1566698400,
        "status": "active"
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/pause_subscription_estimate

pause_option

optional, enumerated string
List of options to pause the subscription.

Possible values are

immediatelyPause immediatelyend_of_termPause at the end of current termspecific_datePause on a specific datebilling_cycles

Pause at the end of the current term, and resume automatically after the number of billing cycles you specify in skip_billing_cycles

unbilled_charges_handling

optional, enumerated string

Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.

Possible values are

no_action

Retain as unbilled

If no_action is chosen, charges are added to the resumption invoice.

invoice

Invoice charges

If invoice is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.

subscription

Parameters for subscription
pass parameters as subscription[<param name>]

subscription[pause_date]

optional, timestamp(UTC) in seconds
When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused state, it is the date/time when the subscription was paused.

subscription[resume_date]

optional, timestamp(UTC) in seconds
For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.

subscription[skip_billing_cycles]

optional, integer, min=1
Number of billing cycles this subscription should be paused. The subscription resumes after the paused billing cycles end.

estimate

always returned
Resource object representing estimate

Generates an estimate for the 'resume subscription' operation. This is similar to the Resume a subscription API, but the subscription will not be resumed. Only an estimate for this operation is created.

In the response,

estimate.subscription_estimate has the subscription details.
estimate.invoice_estimate has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation. This will happen for in-term resumption⁺⁺.

⁺⁺What is an "in-term resumption"?
An “in-term resumption” is when the resumption happens within the billing term of the subscription.
estimate.next_invoice_estimate has details of the invoice that will be generated during the next billing date of this subscription. This will be present only if no immediate invoice is generated during this operation (scenario mentioned above) and this subscription has next billing.

The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__sZEDgk5GSLmdy3v6t/resume_subscription_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d resume_option="immediately"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__sZEDgk5GSLmdy3v6t/resume_subscription_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d resume_option="immediately"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517484176,
    "next_invoice_estimate": {
        "amount_due": 895,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__sZEDgk5GSLmdy3v6t",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 895,
                "customer_id": "__test__sZEDgk5GSLmdy3v6t",
                "date_from": 1519903375,
                "date_to": 1522581775,
                "description": "No Trial",
                "discount_amount": 0,
                "entity_id": "no_trial",
                "entity_type": "plan",
                "id": "li___test__sZEDgk5GSLmdyDV73",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "subscription_id": "__test__sZEDgk5GSLmdy3v6t",
                "tax_amount": 0,
                "unit_amount": 895
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 895,
        "taxes": [],
        "total": 895
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__sZEDgk5GSLmdy3v6t",
        "next_billing_at": 1519903375,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/resume_subscription_estimate

resume_option

optional, enumerated string
List of options to resume the subscription.

Possible values are

immediatelyResume immediatelyspecific_dateResume on a specific date

charges_handling

optional, enumerated string
Applicable when charges get added during this operation and resume_option is set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.

Possible values are

invoice_immediatelyInvoice immediatelyadd_to_unbilled_chargesAdd to unbilled charges

subscription

Parameters for subscription
pass parameters as subscription[<param name>]

subscription[resume_date]

optional, timestamp(UTC) in seconds
For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.

estimate

always returned
Resource object representing estimate

Generates an estimate for the 'create a gift' operation. This is similar to the Create a gift API, but the gift subscription will not be created. Only an estimate for this operation is created.

In the response,

estimate.subscription_estimate has the gift subscription details.
estimate.invoice_estimate has details of the gift invoice that will be generated immediately.

Sample Request

curl  https://{site}.chargebee.com/api/v2/estimates/gift_subscription \
     -u {site_api_key}:\
     -d subscription[plan_id]="GiftPlan$100" \
     -d gifter[customer_id]="gifter" \
     -d gifter[signature]="Sam" \
     -d gift_receiver[customer_id]="receiver" \
     -d gift_receiver[first_name]="James" \
     -d gift_receiver[last_name]="William" \
     -d gift_receiver[email]="james@user.com"

copy

curl  https://{site}.chargebee.com/api/v2/estimates/gift_subscription \
     -u {site_api_key}:\
     -d subscription[plan_id]="GiftPlan$100" \
     -d gifter[customer_id]="gifter" \
     -d gifter[signature]="Sam" \
     -d gift_receiver[customer_id]="receiver" \
     -d gift_receiver[first_name]="James" \
     -d gift_receiver[last_name]="William" \
     -d gift_receiver[email]="james@user.com"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505706,
    "invoice_estimate": {
        "amount_due": 10000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "gifter",
        "date": 1517505705,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 10000,
                "customer_id": "gifter",
                "date_from": 1612200110,
                "date_to": 1614619310,
                "description": "New Year Gift",
                "discount_amount": 0,
                "entity_id": "GiftPlan$100",
                "entity_type": "plan",
                "id": "li___test__KyVnHhSBWl16u2a9",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "subscription_id": "__test__KyVnHhSBWl15j2a7",
                "tax_amount": 0,
                "unit_amount": 10000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 10000,
        "taxes": [],
        "total": 10000
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__KyVnHhSBWl15j2a7",
        "object": "subscription_estimate",
        "status": "future"
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/estimates/gift_subscription

coupon_ids[0..n]

optional, list of string
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.

gift

Parameters for gift
pass parameters as gift[<param name>]

gift[scheduled_at]

optional, timestamp(UTC) in seconds
Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.

gift[auto_claim]

optional, boolean
When true, the claim happens automatically. When not passed, the default value in the site settings is used.

gift[no_expiry]

optional, boolean
When true, indicates that the gift does not expire. Do not pass or pass as false when auto_claim is set.

gift[claim_expiry_date]

optional, timestamp(UTC) in seconds
The date until which the gift can be claimed. Must be set to a value after scheduled_at. If the gift is not claimed within claim_expiry_date, it will expire and the subscription will move to cancelled state. When not passed, the value specified in the site settings will be used. Pass as NULL or do not pass when auto_claim or no_expiry are set.

gifter

Parameters for gifter
pass parameters as gifter[<param name>]

gifter[customer_id]

required, string, max chars=50
Gifter customer id.

gifter[signature]

required, string, max chars=50
Gifter sign-off name

gifter[note]

optional, string, max chars=500
Personalized message for the gift.

gifter[payment_src_id]

optional, string, max chars=40
Identifier of the payment source

gift_receiver

Parameters for gift_receiver
pass parameters as gift_receiver[<param name>]

gift_receiver[customer_id]

required, string, max chars=50
Receiver customer id.

gift_receiver[first_name]

required, string, max chars=150
First name of the receiver as given by the gifter.

gift_receiver[last_name]

required, string, max chars=150
Last name of the receiver as given by the gifter,

gift_receiver[email]

required, string, max chars=70
Email of the receiver. All gift related emails are sent to this email.

payment_intent

Parameters for payment_intent
pass parameters as payment_intent[<param name>]

payment_intent[id]

optional, string, max chars=150
Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.

payment_intent[gateway_account_id]

required if payment intent token provided, string, max chars=50
The gateway account used for performing the 3DS flow.

payment_intent[gw_token]

optional, string, max chars=65k
Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.

payment_intent[payment_method_type]

optional, enumerated string
The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.

Possible values are

cardcardidealidealsofortsofortbancontactbancontact

google_paygoogle_paydotpaydotpaygiropaygiropayapple_payapple_payupiupinetbanking_emandatesnetbanking_emandatespaypal_express_checkoutpaypal_express_checkoutdirect_debitdirect_debitboletoboletovenmoamazon_paymentsamazon_paymentspay_tofaster_paymentssepa_instant_transfer

Show all values[+]

payment_intent[reference_id]

optional, string, max chars=65k
Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.

payment_intent[additional_information]

optional, jsonobject

checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
- payer: User related information.
  - country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
  - document: Document ID is the user’s identification number based on their country.
bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
- fraud: Fraud identification related information.
  - fraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.
braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
- fraud: Fraud identification related information.
  - device_session_id: Session ID associated with the user's device.
  - fraud_merchant_id: Your merchant ID for fraud detection.
chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
- fraud: Fraud identification related information.
  - fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[first_name]

optional, string, max chars=150
The first name of the contact.

shipping_address[last_name]

optional, string, max chars=150
The last name of the contact.

shipping_address[email]

optional, string, max chars=70
The email address.

shipping_address[company]

optional, string, max chars=250
The company name.

shipping_address[phone]

optional, string, max chars=50
The phone number.

shipping_address[line1]

optional, string, max chars=150
Address line 1

shipping_address[line2]

optional, string, max chars=150
Address line 2

shipping_address[line3]

optional, string, max chars=150
Address line 3

shipping_address[city]

optional, string, max chars=50
The name of the city.

shipping_address[state_code]

shipping_address[state]

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

shipping_address[zip]

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

shipping_address[country]

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

shipping_address[validation_status]

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

subscription

Parameters for subscription
pass parameters as subscription[<param name>]

subscription[plan_id]

required, string, max chars=100
Identifier of the plan for this subscription

subscription[plan_quantity]

optional, integer, default=1, min=1
Plan quantity for this subscription

subscription[plan_quantity_in_decimal]

optional, string, max chars=33
Plan Quantity for this subscription in Multi Decimal

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.

addons[quantity][0..n]

optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.

estimate

always returned
Resource object representing 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.

In the response,

estimate.invoice_estimate has details of the invoice that will be generated immediately.

Sample Request

curl  https://{site}.chargebee.com/api/v2/estimates/create_invoice \
     -u {site_api_key}:\
     -d invoice[customer_id]="__test__KyVnHhSBWl0D02Zw" \
     -d charges[amount][0]=1000 \
     -d charges[description][0]="Adhoc charge"

copy

curl  https://{site}.chargebee.com/api/v2/estimates/create_invoice \
     -u {site_api_key}:\
     -d invoice[customer_id]="__test__KyVnHhSBWl0D02Zw" \
     -d charges[amount][0]=1000 \
     -d charges[description][0]="Adhoc charge"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517505702,
    "invoice_estimate": {
        "amount_due": 1000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWl0D02Zw",
        "date": 1517505702,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__KyVnHhSBWl0D02Zw",
                "date_from": 1517505702,
                "date_to": 1517505702,
                "description": "Adhoc charge",
                "discount_amount": 0,
                "entity_type": "adhoc",
                "id": "li___test__KyVnHhSBWl0F22Zz",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": false,
        "round_off_amount": 0,
        "sub_total": 1000,
        "taxes": [],
        "total": 1000
    },
    "object": "estimate"
}}

URL Format POST

https://{site}.chargebee.com/api/v2/estimates/create_invoice

currency_code

required if Multicurrency is enabled, string, max chars=3
The currency code (ISO 4217 format) of the invoice amount.

invoice_note

optional, string, max chars=2000
A note for this particular invoice. This, and all other notes for the invoice are displayed on the PDF invoice sent to the customer.

remove_general_note

optional, boolean, default=false
Set as true to remove the general note from this invoice.

coupon_ids[0..n]

optional, list of string
List of Coupons to be added.

authorization_transaction_id

optional, string, max chars=40
Authorization transaction to be captured.

payment_source_id

optional, string, max chars=40
Payment source to be used for this payment.

auto_collection

optional, enumerated string
The customer level auto collection will be override if specified.

Possible values are

onWhenever an invoice is created, an automatic attempt will be made to charge.offWhenever an invoice is created as payment due.

invoice_date

invoice

Parameters for invoice
pass parameters as invoice[<param name>]

invoice[customer_id]

optional, string, max chars=50
Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.

invoice[subscription_id]

optional, string, max chars=50
Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.(not applicable for consolidated invoice)

invoice[po_number]

optional, string, max chars=100
Purchase Order Number for this invoice.

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[first_name]

optional, string, max chars=150
The first name of the contact.

shipping_address[last_name]

optional, string, max chars=150
The last name of the contact.

shipping_address[email]

optional, string, max chars=70
The email address.

shipping_address[company]

optional, string, max chars=250
The company name.

shipping_address[phone]

optional, string, max chars=50
The phone number.

shipping_address[line1]

optional, string, max chars=150
Address line 1

shipping_address[line2]

optional, string, max chars=150
Address line 2

shipping_address[line3]

optional, string, max chars=150
Address line 3

shipping_address[city]

optional, string, max chars=50
The name of the city.

shipping_address[state_code]

shipping_address[state]

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

shipping_address[zip]

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

shipping_address[country]

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

shipping_address[validation_status]

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.

addons[quantity][0..n]

optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

addons[quantity_in_decimal][0..n]

optional, string, max chars=33
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.

addons[unit_price][0..n]

optional, in cents, min=0

The price or per-unit-price of the addon. The value depends on the type of currency.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

The unit_price provided is $10
The addon billing period is 1 month.
The plan billing period is 3 months.
The addon is only billed for $10 on each subscription renewal.

addons[unit_price_in_decimal][0..n]

optional, string, max chars=39

The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

The unit_price_in_decimal provided is $10.75
The addon billing period is 1 month.
The plan billing period is 3 months.
The addon is only billed for $10.75 on each subscription renewal.

addons[date_from][0..n]

optional, timestamp(UTC) in seconds
The time when the service period for the addon starts.

addons[date_to][0..n]

optional, timestamp(UTC) in seconds
The time when the service period for the addon ends.

charges

Parameters for charges. Multiple charges can be passed by specifying unique indices.
pass parameters as charges[<param name>][<idx:0..n>]

charges[amount][0..n]

optional, in cents, min=1
The amount to be charged. The unit depends on the type of currency.

charges[amount_in_decimal][0..n]

optional, string, max chars=39
The decimal representation of the amount for the one-time charge. Provide the value in major units of the currency. Can be provided only when multi-decimal pricing is enabled.

charges[description][0..n]

optional, string, max chars=250
Description for this charge

charges[taxable][0..n]

optional, boolean, default=true
The amount to be charged is taxable or not.

charges[tax_profile_id][0..n]

optional, string, max chars=50
Tax profile of the charge.

charges[avalara_tax_code][0..n]

optional, string, max chars=50
The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's AvaTax for Sales integration.

charges[hsn_code][0..n]

optional, string, max chars=50
The HSN code to which the item is mapped for calculating the customer’s tax in India. Applicable only when both of the following conditions are true:

India has been enabled as a Tax Region. (An error is returned when this condition is not true.)
The AvaTax for Sales integration has been enabled in Chargebee.

charges[taxjar_product_code][0..n]

optional, string, max chars=50
The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's TaxJar integration.

charges[avalara_sale_type][0..n]

optional, enumerated string
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

Possible values are

wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax

charges[avalara_transaction_type][0..n]

optional, integer
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

charges[avalara_service_type][0..n]

optional, integer
Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

charges[date_from][0..n]

optional, timestamp(UTC) in seconds
The time when the service period for the charge starts.

charges[date_to][0..n]

optional, timestamp(UTC) in seconds
The time when the service period for the charge ends.

notes_to_remove

Parameters for notes_to_remove. Multiple notes_to_remove can be passed by specifying unique indices.
pass parameters as notes_to_remove[<param name>][<idx:0..n>]

notes_to_remove[entity_type][0..n]

optional, enumerated string
Type of entity to which the note belongs. To remove the general note, use the remove_general_note parameter.

Possible values are

planEntity that represents a plan.addonEntity that represents an addon.customerEntity that represents a customer.subscriptionEntity that represents a subscription of customer.couponEntity that represents a coupon.

notes_to_remove[entity_id][0..n]

optional, string, max chars=100
Unique identifier of the note.

estimate

always returned
Resource object representing estimate

Sample estimate [ JSON ]

Estimate attributes

Subscription estimate attributes

Invoice estimate attributes

Credit note estimate attributes

Unbilled charge estimate attributes

Create subscription estimate¶

Related Tutorial

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Create subscription for a customer estimate¶

Sample Response [ JSON ]

URL Format GET

Input Parameters

Returns

Update subscription estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Subscription renewal estimate¶

Sample Response [ JSON ]

URL Format GET

Input Parameters

Returns

Advance invoice estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Regenerate Invoice Estimate¶

Response

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Upcoming invoices estimate¶

Sample Response [ JSON ]

URL Format GET

Returns

Subscription change term end estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Cancel subscription estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Pause subscription estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Resume subscription estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Gift subscription estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Create invoice estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns