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": 1612964957,
    "invoice_estimate": {
        "amount_due": 1100,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8asyKSOceaKFNz",
        "date": 1612964957,
        "line_item_discounts": [],
        "line_item_taxes": [
            {
                "is_non_compliance_tax": false,
                "is_partial_tax_applied": false,
                "line_item_id": "li___test__8asyKSOceaN3O1",
                "object": "line_item_tax",
                "tax_amount": 91,
                "tax_name": "Tax",
                "tax_rate": 10,
                "taxable_amount": 909
            },
            {
                "is_non_compliance_tax": false,
                "is_partial_tax_applied": false,
                "line_item_id": "li___test__8asyKSOceaNSO2",
                "object": "line_item_tax",
                "tax_amount": 9,
                "tax_name": "Tax",
                "tax_rate": 10,
                "taxable_amount": 91
            }
        ],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__8asyKSOceaKFNz",
                "date_from": 1612964957,
                "date_to": 1615384157,
                "description": "basic USD",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "li___test__8asyKSOceaN3O1",
                "is_taxed": true,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "tax_amount": 91,
                "tax_rate": 10,
                "unit_amount": 1000
            },
            {
                "amount": 100,
                "customer_id": "__test__8asyKSOceaKFNz",
                "date_from": 1612964957,
                "date_to": 1615384157,
                "description": "Day Pass USD Monthly",
                "discount_amount": 0,
                "entity_id": "day-pass-USD",
                "entity_type": "addon_item_price",
                "id": "li___test__8asyKSOceaNSO2",
                "is_taxed": true,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 9,
                "tax_rate": 10,
                "unit_amount": 100
            }
        ],
        "object": "invoice_estimate",
        "price_type": "tax_inclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 1100,
        "taxes": [{
            "amount": 100,
            "description": "Tax @ 10%",
            "name": "Tax",
            "object": "tax"
        }],
        "total": 1100
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1615384157,
        "object": "subscription_estimate",
        "status": "active"
    }
}

created_at

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

subscription_estimate

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

invoice_estimate

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

invoice_estimates

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.
optional, list of invoice_estimate

next_invoice_estimate

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

credit_note_estimates

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

unbilled_charge_estimates

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

id

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

currency_code

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

status

The status of the subscription.
optional, enumerated string

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

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.
optional, enumerated string

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 trail_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 trail_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

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

pause_date

The date at which subscription will be paused. Applicable only for paused or schedule pause subscription.
optional, timestamp(UTC) in seconds

resume_date

The date at which subscription will be resumed. Applicable only for paused or schedule pause subscription.
optional, timestamp(UTC) in seconds

shipping_address
Show attributes[+]

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

Shipping address attributes

first_name

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

last_name

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

email

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

company

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

phone

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

line1

Address line 1.
optional, string, max chars=180

line2

Address line 2.
optional, string, max chars=150

line3

Address line 3.
optional, string, max chars=150

city

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

state_code

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).
optional, string, max chars=50

state

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

country

2-letter, ISO 3166 alpha-2 country code.

If you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, string, max chars=50

zip

Zip or Postal code.
optional, string, max chars=20

validation_status

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

contract_term
Show attributes[+]

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

Contract term attributes

id

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

status

Current status of contract.
enumerated string

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

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

contract_end

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

billing_cycle

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

action_at_term_end

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

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

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.
in cents, default=0, min=0

cancellation_cutoff_period

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.
optional, integer

created_at

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

subscription_id

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

remaining_billing_cycles

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

recurring

Will be 'true' for subscription related estimates.
boolean, default=true

price_type

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

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

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

sub_total

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

total

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

credits_applied

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

amount_paid

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

amount_due

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

round_off_amount

Indicates the rounded-off amount.
optional, in cents, min=0

customer_id

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

line_items
Show attributes[+]

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

Line item attributes

id

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

subscription_id

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

date_from

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

date_to

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

unit_amount

Unit amount of the line item.
in cents

quantity

Quantity of the recurring item which is represented by this line item. For metered line items, this value is updated from usages once when the invoice is generated as pending and finally when the invoice is closed.
optional, integer, default=1

amount

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

pricing_model

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

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

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

tax_amount

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

tax_rate

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

unit_amount_in_decimal

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.
optional, string, max chars=33

quantity_in_decimal

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

amount_in_decimal

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.
optional, string, max chars=33

discount_amount

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

item_level_discount_amount

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

description

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

entity_description

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

entity_type

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

Possible values are

adhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case.plan_item_priceIndicates that this line item is based on plan Item Price.addon_item_priceIndicates that this line item is based on addon Item Price.charge_item_priceIndicates that this line item is based on charge Item Price.

tax_exempt_reason

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

Possible values are

tax_not_configuredIf tax is not enabled for the site.region_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 jurisdiction.exportYou 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 respectively.customer_exemptIf the Customer is marked as Tax exempt.product_exemptIf the Plan or Addon is marked as Tax exempt.zero_ratedIf the rate of tax is 0% and no Sales/ GST tax is collectable for that line item.reverse_chargeIf the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only.high_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 applied.

entity_id

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

customer_id

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

discounts
Show attributes[+]

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

Discount attributes

amount

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

description

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

line_item_id

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.
optional, string, max chars=40

entity_type

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

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.item_level_discount(Beta) The deduction is due to a discount applied to a line item of the invoice. The discount id is available as the entity_id.document_level_discount(Beta) The deduction is due to a discount applied to the invoice sub_total. The discount id is available as the entity_id.

discount_type

The type of discount that is applied to the line item. Relevant only when discounts[entity_type] is one of item_level_discount , item_level_coupon, document_level_discount, or document_level_coupon.
optional, enumerated string

Possible values are

fixed_amountwhen amount is applied as discount.percentagewhen percentage is applied as discount.

entity_id

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

taxes
Show attributes[+]

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

Tax attributes

name

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

amount

The tax amount.
in cents, min=0

description

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

line_item_taxes
Show attributes[+]

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

Line item tax attributes

line_item_id

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

tax_name

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

tax_rate

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

is_partial_tax_applied

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

is_non_compliance_tax

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

taxable_amount

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

tax_amount

The tax amount.
in cents, min=0

tax_juris_type

The type of tax jurisdiction.
optional, enumerated string

Possible values are

countryThe tax jurisdiction is a country.federalThe tax jurisdiction is a federal.stateThe tax jurisdiction is a state.countyThe tax jurisdiction is a county.cityThe tax jurisdiction is a city.specialSpecial tax jurisdiction.unincorporatedCombined tax of state and county.otherJurisdictions other than the ones listed above.

tax_juris_name

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

tax_juris_code

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

tax_amount_in_local_currency

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

local_currency_code

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.
optional, string, max chars=null

line_item_tiers
Show attributes[+]

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

Line item tier attributes

line_item_id

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

starting_unit

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

ending_unit

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

quantity_used

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

unit_amount

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.
in cents, min=0

starting_unit_in_decimal

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.
optional, string, max chars=33

ending_unit_in_decimal

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.
optional, string, max chars=33

quantity_used_in_decimal

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

unit_amount_in_decimal

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.
optional, string, max chars=40

line_item_discounts
Show attributes[+]

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

Line item discount attributes

line_item_id

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

discount_type

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

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.item_level_discount(Beta) The deduction is due to a discount applied to a line item of the invoice. The discount id is available as the entity_id.document_level_discount(Beta) The deduction is due to a discount applied to the invoice sub_total. The discount id is available as the entity_id.

entity_id

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

discount_amount

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

reference_invoice_id

The reference invoice id.
string, max chars=50

type

Credit note type.
enumerated string

Possible values are

adjustmentAdjustment Credit Note.refundableRefundable Credit Note.

price_type

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

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

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

sub_total

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

total

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

amount_allocated

Allocated credits in cents.
in cents, min=0

amount_available

Remaining credits in cents.
in cents, min=0

round_off_amount

Indicates the rounded-off amount.
optional, in cents, min=0

customer_id

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

line_items
Show attributes[+]

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

Line item attributes

id

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

subscription_id

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

date_from

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

date_to

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

unit_amount

Unit amount of the line item.
in cents

quantity

amount

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

pricing_model

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

Possible values are

is_taxed

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

tax_amount

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

tax_rate

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

unit_amount_in_decimal

quantity_in_decimal

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

amount_in_decimal

discount_amount

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

item_level_discount_amount

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

description

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

entity_description

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

entity_type

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

Possible values are

tax_exempt_reason

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

Possible values are

entity_id

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

customer_id

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

discounts
Show attributes[+]

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

Discount attributes

amount

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

description

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

line_item_id

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.
optional, string, max chars=40

entity_type

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

Possible values are

discount_type

Possible values are

fixed_amountwhen amount is applied as discount.percentagewhen percentage is applied as discount.

entity_id

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

taxes
Show attributes[+]

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

Tax attributes

name

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

amount

The tax amount.
in cents, min=0

description

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

line_item_taxes
Show attributes[+]

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

Line item tax attributes

line_item_id

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

tax_name

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

tax_rate

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

is_partial_tax_applied

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

is_non_compliance_tax

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

taxable_amount

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

tax_amount

The tax amount.
in cents, min=0

tax_juris_type

The type of tax jurisdiction.
optional, enumerated string

Possible values are

tax_juris_name

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

tax_juris_code

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

tax_amount_in_local_currency

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

local_currency_code

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.
optional, string, max chars=null

line_item_discounts
Show attributes[+]

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

Line item discount attributes

line_item_id

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

discount_type

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

Possible values are

entity_id

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

discount_amount

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

line_item_tiers
Show attributes[+]

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

Line item tier attributes

line_item_id

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

starting_unit

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

ending_unit

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

quantity_used

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

unit_amount

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.
in cents, min=0

starting_unit_in_decimal

ending_unit_in_decimal

quantity_used_in_decimal

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

unit_amount_in_decimal

id

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

customer_id

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

subscription_id

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

date_from

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

date_to

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

unit_amount

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

pricing_model

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

Possible values are

quantity

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

amount

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

currency_code

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

discount_amount

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

description

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

entity_type

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

Possible values are

entity_id

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

is_voided

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

voided_at

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

unit_amount_in_decimal

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.
optional, string, max chars=33

quantity_in_decimal

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

amount_in_decimal

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.
optional, string, max chars=33

deleted

Indicates that this resource has been deleted.
boolean

tiers
Show attributes[+]

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

Tier attributes

line_item_id

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

starting_unit

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

ending_unit

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

quantity_used

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

unit_amount

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.
in cents, min=0

starting_unit_in_decimal

ending_unit_in_decimal

quantity_used_in_decimal

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

unit_amount_in_decimal

Generates an estimate for creating a subscription when the customer does not exist in Chargebee. This estimate API can be called when the customer has not yet signed up and you want to preview how a new subscription would look like for them.

Note: Estimate operations do not make any changes in Chargebee; hence this API does not create an actual customer or subscription record.

The response contains one or more of the following objects:

subscription_estimate: The subscription details like the status of the subscription (such as in_trial or active), next billing date, and so on.
invoice_estimate:The details of the immediate invoice, if there is one. If the subscription is created in trial/future states, invoice_estimate is unavailable as no immediate invoice is generated.
next_invoice_estimate:This is returned when an immediate invoice is not generated. It contains the details of the invoice that will be generated on the next billing date of the subscription.
unbilled_charge_estimates: This contains the details of charges that have not been invoiced. This is returned only if the invoice_immediately parameter is set to false.

Sample Request

curl  https://{site}.chargebee.com/api/v2/estimates/create_subscription_for_items \
     -u {site_api_key}:\
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US" \
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[billing_cycles][0]=2 \
     -d subscription_items[quantity][0]=1 \
     -d subscription_items[item_price_id][1]="day-pass-USD" \
     -d subscription_items[unit_price][1]=100 \
     -d customer[taxability]="taxable"

copy

curl  https://{site}.chargebee.com/api/v2/estimates/create_subscription_for_items \
     -u {site_api_key}:\
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US" \
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[billing_cycles][0]=2 \
     -d subscription_items[quantity][0]=1 \
     -d subscription_items[item_price_id][1]="day-pass-USD" \
     -d subscription_items[unit_price][1]=100 \
     -d customer[taxability]="taxable"

# Create subscription with tier price override
curl  https://{site}.chargebee.com/api/v2/estimates/create_subscription_for_items \
     -u {site_api_key}:\
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US" \
     -d subscription_items[item_price_id][0]="basic-USD-yearly" \
     -d subscription_items[billing_cycles][0]=2 \
     -d subscription_items[quantity][0]=1 \
     -d item_tiers[item_price_id][0]="basic-USD-yearly" \
     -d item_tiers[starting_unit][0]=1 \
     -d item_tiers[ending_unit][0]=10 \
     -d item_tiers[price][0]=1000 \
     -d item_tiers[item_price_id][1]="basic-USD-yearly" \
     -d item_tiers[starting_unit][1]=11 \
     -d item_tiers[ending_unit][1]=20 \
     -d item_tiers[price][1]=2500 \
     -d item_tiers[item_price_id][2]="basic-USD-yearly" \
     -d item_tiers[starting_unit][2]=21 \
     -d item_tiers[price][2]=4000 \
     -d customer[taxability]="exempt"

# Create subscription with trial
curl  https://{site}.chargebee.com/api/v2/estimates/create_subscription_for_items \
     -u {site_api_key}:\
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US" \
     -d subscription_items[item_price_id][0]="basic-USD-weekly"

# Create subscription with unbilled charges
curl  https://{site}.chargebee.com/api/v2/estimates/create_subscription_for_items \
     -u {site_api_key}:\
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US" \
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[billing_cycles][0]=2 \
     -d subscription_items[quantity][0]=1 \
     -d subscription_items[item_price_id][1]="day-pass-USD" \
     -d subscription_items[unit_price][1]=100 \
     -d invoice_immediately="false"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1612964957,
    "invoice_estimate": {
        "amount_due": 1100,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8asyKSOceaKFNz",
        "date": 1612964957,
        "line_item_discounts": [],
        "line_item_taxes": [
            {
                "is_non_compliance_tax": false,
                "is_partial_tax_applied": false,
                "line_item_id": "li___test__8asyKSOceaN3O1",
                "object": "line_item_tax",
                "tax_amount": 91,
                "tax_name": "Tax",
                "tax_rate": 10,
                "taxable_amount": 909
            },
            {..}
        ],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__8asyKSOceaKFNz",
                "date_from": 1612964957,
                "date_to": 1615384157,
                "description": "basic USD",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "li___test__8asyKSOceaN3O1",
                "is_taxed": true,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "tax_amount": 91,
                "tax_rate": 10,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_inclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 1100,
        "taxes": [
            {
                "amount": 100,
                "description": "Tax @ 10%",
                "name": "Tax",
                "object": "tax"
            },
            {..}
        ],
        "total": 1100
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1615384157,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

{"estimate": {
    "created_at": 1606746240,
    "invoice_estimate": {
        "amount_due": 909,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8at0MSHpnTkzN",
        "date": 1606746240,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_item_tiers": [
            {
                "ending_unit": 10,
                "line_item_id": "li___test__8at0MSHpnTlyP",
                "object": "line_item_tier",
                "quantity_used": 1,
                "starting_unit": 1,
                "unit_amount": 909
            },
            {..}
        ],
        "line_items": [
            {
                "amount": 909,
                "customer_id": "__test__8at0MSHpnTkzN",
                "date_from": 1606746240,
                "date_to": 1638282240,
                "description": "basic USD yearly",
                "discount_amount": 0,
                "entity_id": "basic-USD-yearly",
                "entity_type": "plan_item_price",
                "id": "li___test__8at0MSHpnTlyP",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "tiered",
                "quantity": 1,
                "tax_amount": 0,
                "tax_exempt_reason": "customer_exempt",
                "unit_amount": 909
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_inclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 909,
        "taxes": [],
        "total": 909
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1638282240,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

{"estimate": {
    "created_at": 1606746240,
    "next_invoice_estimate": {
        "amount_due": 3000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8at0MSHpnTqLR",
        "date": 1607351040,
        "line_item_discounts": [],
        "line_item_taxes": [
            {
                "is_non_compliance_tax": false,
                "is_partial_tax_applied": false,
                "line_item_id": "li___test__8at0MSHpnTrGT",
                "object": "line_item_tax",
                "tax_amount": 273,
                "tax_name": "Tax",
                "tax_rate": 10,
                "taxable_amount": 2727
            },
            {..}
        ],
        "line_items": [
            {
                "amount": 3000,
                "customer_id": "__test__8at0MSHpnTqLR",
                "date_from": 1607351040,
                "date_to": 1607955840,
                "description": "basic USD weekly",
                "discount_amount": 0,
                "entity_id": "basic-USD-weekly",
                "entity_type": "plan_item_price",
                "id": "li___test__8at0MSHpnTrGT",
                "is_taxed": true,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 273,
                "tax_rate": 10,
                "unit_amount": 3000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_inclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 3000,
        "taxes": [
            {
                "amount": 273,
                "description": "Tax @ 10%",
                "name": "Tax",
                "object": "tax"
            },
            {..}
        ],
        "total": 3000
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1607351040,
        "object": "subscription_estimate",
        "status": "in_trial"
    }
}}

{"estimate": {
    "created_at": 1606746240,
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1609338240,
        "object": "subscription_estimate",
        "status": "active"
    },
    "unbilled_charge_estimates": [
        {
            "amount": 1000,
            "currency_code": "USD",
            "customer_id": "__test__8at0MSHpnTwBW",
            "date_from": 1606746240,
            "date_to": 1609338240,
            "deleted": false,
            "description": "basic USD",
            "discount_amount": 0,
            "entity_id": "basic-USD",
            "entity_type": "plan_item_price",
            "id": "li___test__8at0MSHpnTzAY",
            "is_voided": false,
            "object": "unbilled_charge",
            "pricing_model": "per_unit",
            "quantity": 1,
            "unit_amount": 1000
        },
        {..}
    ]
}}

URL Format POST

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

billing_cycles

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

mandatory_items_to_remove[0..n]

Item ids of mandatorily attached addons that are to be removed from the subscription.
optional, list of string

terms_to_charge

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

billing_alignment_mode

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.
optional, enumerated string

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]

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

invoice_immediately

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.

.
optional, boolean

invoice_date

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.
optional, timestamp(UTC) in seconds

client_profile_id

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

subscription

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

subscription[id]

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

subscription[trial_end]

End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date. Set it to 0 to have no trial period.
optional, timestamp(UTC) in seconds

subscription[start_date]

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.

.
optional, timestamp(UTC) in seconds

subscription[free_period]

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.
optional, integer, min=1

subscription[free_period_unit]

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.
optional, enumerated string

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]

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.
optional, integer, min=1, max=100

subscription[trial_end_action]

Possible values are

billing_address

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

billing_address[line1]

Address line 1.
optional, string, max chars=150

billing_address[line2]

Address line 2.
optional, string, max chars=150

billing_address[line3]

Address line 3.
optional, string, max chars=150

billing_address[city]

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

billing_address[state_code]

billing_address[zip]

Zip or Postal code.
optional, string, max chars=20

billing_address[country]

billing_address[validation_status]

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

shipping_address

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

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

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

shipping_address[state_code]

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

shipping_address[validation_status]

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

customer

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

customer[vat_number]

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.
optional, string, max chars=20

customer[vat_number_prefix]

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.
optional, string, max chars=10

customer[registered_for_gst]

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

customer[taxability]

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

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]

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

Possible values are

aFederal government.bState government.cTribe/Status Indian/Indian Band.dForeign diplomat.

eCharitable or benevolent organization.fReligious organization.gResale.hCommercial agricultural production.iIndustrial production/manufacturer.jDirect pay permit.kDirect mail.lOther or custom.mEducational organization.nLocal government.pCommercial aquaculture.qCommercial Fishery.rNon-resident.med1US Medical Device Excise Tax with exempt sales tax.med2US Medical Device Excise Tax with taxable sales tax.

Show all values[+]

customer[exempt_number]

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.
optional, string, max chars=100

customer[exemption_details]

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.
optional, jsonarray

customer[customer_type]

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

Possible values are

residentialWhen the purchase is made by a customer for home use.businessWhen the purchase is made at a place of business.senior_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 breaks.industrialWhen 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]

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

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]

subscription_items

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

subscription_items[item_price_id][0..n]

The unique identifier of the item price.
required, string, max chars=100

subscription_items[quantity][0..n]

The quantity of the item purchased.
optional, integer, min=1

subscription_items[quantity_in_decimal][0..n]

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

subscription_items[unit_price][0..n]

The price/per unit price of the item. When not provided, the value set for the item price is used. This is only applicable when the pricing_model of the item price is flat_fee or per_unit. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If changes_scheduled_at is in the past and a unit_price is not passed, then the item price’s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
optional, in cents, min=0

subscription_items[unit_price_in_decimal][0..n]

subscription_items[billing_cycles][0..n]

For the plan-item price:
the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used.

For addon-item prices:
If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
optional, integer, min=0

subscription_items[trial_end][0..n]

The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.
optional, timestamp(UTC) in seconds

subscription_items[service_period_days][0..n]

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

subscription_items[charge_on_event][0..n]

When charge_on_option option is set to on_event, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
optional, enumerated string

Possible values are

subscription_creationthe time of creation of the subscription.subscription_trial_startthe time when the trial period of the subscription begins.plan_activationsame as subscription activation, but also includes the case when the plan-item of the subscription is changed.subscription_activationthe moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.contract_terminationwhen a contract term is terminated.

subscription_items[charge_once][0..n]

Indicates if the charge-item is to be charged only once or each time the charge_on_event occurs. This parameter only applies to charge-items.
optional, boolean

subscription_items[charge_on_option][0..n]

Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
optional, enumerated string

Possible values are

immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.

discounts

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

discounts[apply_on][0..n]

The amount on the invoice to which the discount is applied.
required, enumerated string

Possible values are

invoice_amountThe discount is applied to the invoice sub_total.specific_item_priceThe discount is applied to the invoice.line_item.amount that corresponds to the item price specified by item_price_id.

discounts[duration_type][0..n]

Specifies the time duration for which this discount is attached to the subscription.
required, enumerated string, default=forever

Possible values are

one_timeThe discount stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.foreverThe discount is attached to the subscription and applied on the invoices till it is explicitly removed.limited_periodThe discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit.

discounts[percentage][0..n]

The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
optional, double, min=0.01, max=100.0

discounts[amount][0..n]

The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
optional, in cents, min=0

discounts[period][0..n]

The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
optional, integer, min=1

discounts[period_unit][0..n]

The unit of time for period. Applicable only when duration_type is limited_period.
optional, enumerated string

Possible values are

dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.

discounts[included_in_mrr][0..n]

Set this to false if this coupon should be excluded from monthly recurring revenue (MRR) calculations for the site. The following prerequisites must be met to allow this parameter to be passed:

The discount duration_type must be one_time.
The feature must be enabled in Chargebee.
The site-level setting must be to include coupons in MRR calculations. The site level setting is also the default value for the attribute when this parameter is not passed.

.
optional, boolean

discounts[item_price_id][0..n]

The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
optional, string, max chars=100

item_tiers

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

item_tiers[item_price_id][0..n]

The id of the item price for which the tier price is being overridden.
optional, string, max chars=100

item_tiers[starting_unit][0..n]

The lowest value in the quantity tier.
optional, integer, min=1

item_tiers[ending_unit][0..n]

The highest value in the quantity tier.
optional, integer

item_tiers[price][0..n]

The overridden price of the tier. The value depends on the type of currency.
optional, in cents, default=0, min=0

item_tiers[starting_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[ending_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[price_in_decimal][0..n]

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 the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
optional, string, max chars=33

estimate

Resource object representing estimate.
always returned

Notes

The following conditions must be met or tax calculation is ignored:

The taxability attribute for the customer is true.
shipping_address is passed when needed for tax calculation.

Sample Request

curl  https://{site}.chargebee.com/api/v2/customers/__test__8aspfRrLYZEd2/create_subscription_for_items_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[billing_cycles][0]=2 \
     -d subscription_items[quantity][0]=1 \
     -d subscription_items[item_price_id][1]="day-pass-USD" \
     -d subscription_items[unit_price][1]=100

copy

curl  https://{site}.chargebee.com/api/v2/customers/__test__8aspfRrLYZEd2/create_subscription_for_items_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[billing_cycles][0]=2 \
     -d subscription_items[quantity][0]=1 \
     -d subscription_items[item_price_id][1]="day-pass-USD" \
     -d subscription_items[unit_price][1]=100

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1612964956,
    "invoice_estimate": {
        "amount_due": 1100,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8asyKSOcea0qNl",
        "date": 1612964956,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__8asyKSOcea0qNl",
                "date_from": 1612964956,
                "date_to": 1615384156,
                "description": "basic USD",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "li___test__8asyKSOcea6xNq",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 1100,
        "taxes": [],
        "total": 1100
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "next_billing_at": 1615384156,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format POST

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

use_existing_balances

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

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.

.
optional, boolean

billing_cycles

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

mandatory_items_to_remove[0..n]

Item ids of mandatorily attached addons that are to be removed from the subscription.
optional, list of string

terms_to_charge

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

billing_alignment_mode

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.
optional, enumerated string

Possible values are

invoice_date

coupon_ids[0..n]

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

subscription

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

subscription[id]

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

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.

.
optional, timestamp(UTC) in seconds

subscription[free_period]

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.
optional, integer, min=1

subscription[free_period_unit]

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.
optional, enumerated string

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]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

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

shipping_address[state_code]

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

shipping_address[validation_status]

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

contract_term

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

contract_term[action_at_term_end]

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

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]

subscription_items

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

subscription_items[item_price_id][0..n]

The unique identifier of the item price.
required, string, max chars=100

subscription_items[quantity][0..n]

The quantity of the item purchased.
optional, integer, min=1

subscription_items[quantity_in_decimal][0..n]

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

subscription_items[unit_price][0..n]

subscription_items[unit_price_in_decimal][0..n]

subscription_items[billing_cycles][0..n]

subscription_items[trial_end][0..n]

The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.
optional, timestamp(UTC) in seconds

subscription_items[service_period_days][0..n]

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

subscription_items[charge_on_event][0..n]

Possible values are

subscription_items[charge_once][0..n]

Indicates if the charge-item is to be charged only once or each time the charge_on_event occurs. This parameter only applies to charge-items.
optional, boolean

subscription_items[charge_on_option][0..n]

Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
optional, enumerated string

Possible values are

immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.

discounts

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

discounts[apply_on][0..n]

The amount on the invoice to which the discount is applied.
required, enumerated string

Possible values are

discounts[duration_type][0..n]

Specifies the time duration for which this discount is attached to the subscription.
required, enumerated string, default=forever

Possible values are

discounts[percentage][0..n]

The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
optional, double, min=0.01, max=100.0

discounts[amount][0..n]

The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
optional, in cents, min=0

discounts[period][0..n]

The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
optional, integer, min=1

discounts[period_unit][0..n]

The unit of time for period. Applicable only when duration_type is limited_period.
optional, enumerated string

Possible values are

dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.

discounts[included_in_mrr][0..n]

Set this to false if this coupon should be excluded from monthly recurring revenue (MRR) calculations for the site. The following prerequisites must be met to allow this parameter to be passed:

The discount duration_type must be one_time.
The feature must be enabled in Chargebee.
The site-level setting must be to include coupons in MRR calculations. The site level setting is also the default value for the attribute when this parameter is not passed.

.
optional, boolean

discounts[item_price_id][0..n]

The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
optional, string, max chars=100

item_tiers

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

item_tiers[item_price_id][0..n]

The id of the item price for which the tier price is being overridden.
optional, string, max chars=100

item_tiers[starting_unit][0..n]

The lowest value in the quantity tier.
optional, integer, min=1

item_tiers[ending_unit][0..n]

The highest value in the quantity tier.
optional, integer

item_tiers[price][0..n]

The overridden price of the tier. The value depends on the type of currency.
optional, in cents, default=0, min=0

item_tiers[starting_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[ending_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[price_in_decimal][0..n]

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 the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
optional, string, max chars=33

estimate

Resource object representing estimate.
always returned

Returns an estimate for updating a subscription.

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 the plan item prices or addon item prices in subscription_items.
- 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.

Notes

The following conditions must be met or tax calculation is ignored:

The taxability attribute for the customer is true.
Necessary parameters for tax calculation such as the following are passed: billing_address, shipping_address, customer[vat_number]

Sample Request

curl  https://{site}.chargebee.com/api/v2/estimates/update_subscription_for_items \
     -u {site_api_key}:\
     -d subscription[id]="__test__8aspfRrLYaAEA" \
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[quantity][0]=4 \
     -d subscription_items[unit_price][0]=1000 \
     -d invoice_immediately="true"

copy

curl  https://{site}.chargebee.com/api/v2/estimates/update_subscription_for_items \
     -u {site_api_key}:\
     -d subscription[id]="__test__8aspfRrLYaAEA" \
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[quantity][0]=4 \
     -d subscription_items[unit_price][0]=1000 \
     -d invoice_immediately="true"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1612964966,
    "credit_note_estimates": [],
    "invoice_estimate": {
        "amount_due": 3000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8asyKSOcecJ8PM",
        "date": 1612964966,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 3000,
                "customer_id": "__test__8asyKSOcecJ8PM",
                "date_from": 1612964966,
                "date_to": 1615384165,
                "description": "basic USD - Prorated Charges",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "li___test__8asyKSOcecf6PY",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 3,
                "subscription_id": "__test__8asyKSOcecNUPP",
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 3000,
        "taxes": [],
        "total": 3000
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__8asyKSOcecNUPP",
        "next_billing_at": 1615384165,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format POST

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

mandatory_items_to_remove[0..n]

Item ids of mandatorily attached addons that are to be removed from the subscription.
optional, list of string

replace_items_list

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

invoice_date

The document date displayed on the invoice PDF. 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. When not provided, the date is the same as reactivate_from or changes_scheduled_at (the former is considered when both are passed). 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 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 or reactivate_from.
invoice_immediately is true.

.
optional, timestamp(UTC) in seconds

billing_cycles

Billing cycles set for plan-item price is used by default.
optional, integer, min=0

terms_to_charge

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.
optional, integer, min=1

reactivate_from

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.

.
optional, timestamp(UTC) in seconds

billing_alignment_mode

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

Possible values are

coupon_ids[0..n]

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

replace_coupon_list

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

prorate

Raise prorated credits or charges as applicable while changing the subscription. When not provided, the value is taken from the site settings.
optional, boolean

end_of_term

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

force_term_reset

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

reactivate

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

include_delayed_charges

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

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.

.
optional, boolean

subscription

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

subscription[id]

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

subscription[start_date]

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

subscription[trial_end]

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 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.
optional, timestamp(UTC) in seconds

subscription[auto_collection]

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

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]

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

Possible values are

no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.

subscription[free_period]

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.
optional, integer, min=1

subscription[free_period_unit]

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.
optional, enumerated string

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]

Address line 1.
optional, string, max chars=150

billing_address[line2]

Address line 2.
optional, string, max chars=150

billing_address[line3]

Address line 3.
optional, string, max chars=150

billing_address[city]

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

billing_address[state_code]

billing_address[zip]

Zip or Postal code.
optional, string, max chars=20

billing_address[country]

billing_address[validation_status]

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

shipping_address

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

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

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

shipping_address[state_code]

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

shipping_address[validation_status]

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

customer

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

customer[vat_number]

customer[vat_number_prefix]

customer[registered_for_gst]

subscription_items

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

subscription_items[item_price_id][0..n]

The unique identifier of the item price.
required, string, max chars=100

subscription_items[quantity][0..n]

The quantity of the item purchased.
optional, integer, min=1

subscription_items[quantity_in_decimal][0..n]

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

subscription_items[unit_price][0..n]

subscription_items[unit_price_in_decimal][0..n]

When price overriding is enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price 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. If changes_scheduled_at is in the past and a unit_price_in_decimal is not passed, then the item price’s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
optional, string, max chars=33

subscription_items[billing_cycles][0..n]

subscription_items[trial_end][0..n]

The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.
optional, timestamp(UTC) in seconds

subscription_items[service_period_days][0..n]

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

subscription_items[charge_on_event][0..n]

Possible values are

subscription_items[charge_once][0..n]

Indicates if the charge-item is to be charged only once or each time the charge_on_event occurs. This parameter only applies to charge-items.
optional, boolean

subscription_items[charge_on_option][0..n]

Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
optional, enumerated string

Possible values are

immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.

discounts

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

discounts[apply_on][0..n]

The amount on the invoice to which the discount is applied.
required, enumerated string

Possible values are

discounts[duration_type][0..n]

Specifies the time duration for which this discount is attached to the subscription.
required, enumerated string

Possible values are

discounts[percentage][0..n]

The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
optional, double, min=0.01, max=100.0

discounts[amount][0..n]

The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
optional, in cents, min=0

discounts[period][0..n]

The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
optional, integer, min=1

discounts[period_unit][0..n]

The unit of time for period. Applicable only when duration_type is limited_period.
optional, enumerated string

Possible values are

dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.

discounts[included_in_mrr][0..n]

Set this to false if this coupon should be excluded from monthly recurring revenue (MRR) calculations for the site. The following prerequisites must be met to allow this parameter to be passed:

The discount duration_type must be one_time.
The feature must be enabled in Chargebee.
The site-level setting must be to include coupons in MRR calculations. The site level setting is also the default value for the attribute when this parameter is not passed.

.
optional, boolean

discounts[item_price_id][0..n]

The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
optional, string, max chars=100

discounts[operation_type][0..n]

The operation to be carried out for the discount.
required, enumerated string

Possible values are

addThe discount is attached to the subscription.removeThe discount (given by discounts[id]) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip: If you want to replace a discount, remove it and add another in the same API call.

discounts[id][0..n]

An immutable unique id for the discount. It is always auto-generated.
optional, string, max chars=50

item_tiers

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

item_tiers[item_price_id][0..n]

The id of the item price for which the tier price is being overridden.
optional, string, max chars=100

item_tiers[starting_unit][0..n]

The lowest value in the quantity tier.
optional, integer, min=1

item_tiers[ending_unit][0..n]

The highest value in the quantity tier.
optional, integer

item_tiers[price][0..n]

The overridden price of the tier. The value depends on the type of currency.
optional, in cents, min=0

item_tiers[starting_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[ending_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[price_in_decimal][0..n]

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 the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
optional, string, max chars=33

estimate

Resource object representing estimate.
always returned

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__8asyKSOceZXgNK/renewal_estimate \
     -u {site_api_key}:

copy

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

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517492955,
    "invoice_estimate": {
        "amount_due": 1000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8asyKSOceZS2ND",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__8asyKSOceZS2ND",
                "date_from": 1519912154,
                "date_to": 1522590554,
                "description": "basic USD",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "li___test__8asyKSOceZjINU",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "subscription_id": "__test__8asyKSOceZXgNK",
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 1000,
        "taxes": [],
        "total": 1000
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__8asyKSOceZXgNK",
        "next_billing_at": 1519912154,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format GET

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

include_delayed_charges

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

use_existing_balances

ignore_scheduled_cancellation

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

ignore_scheduled_changes

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

estimate

Resource object representing estimate.
always returned

URL Format POST

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

terms_to_charge

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.

.
optional, integer, default=1, min=1

invoice_immediately

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

schedule_type

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

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]

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.
optional, integer, min=1

fixed_interval_schedule[days_before_renewal]

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

fixed_interval_schedule[end_schedule_on]

Specifies when the schedule should end.
optional, enumerated string

Possible values are

after_number_of_intervalsAdvance invoices are generated a specified number of times.specific_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]

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.
optional, timestamp(UTC) in seconds

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]

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

specific_dates_schedule[date][0..n]

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.
optional, timestamp(UTC) in seconds

estimate

Resource object representing estimate.
always returned

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.

URL Format POST

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

date_from

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

date_to

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

prorate

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

invoice_immediately

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

estimate

Resource object representing estimate.
always returned

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__8asyKSOcec7pP6/upcoming_invoices_estimate \
     -u {site_api_key}:

copy

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

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517492965,
    "invoice_estimates": [
        {
            "amount_due": 2000,
            "amount_paid": 0,
            "credits_applied": 0,
            "currency_code": "USD",
            "customer_id": "__test__8asyKSOcec7pP6",
            "date": 1517492965,
            "line_item_discounts": [],
            "line_item_taxes": [],
            "line_items": [
                {
                    "amount": 1000,
                    "customer_id": "__test__8asyKSOcec7pP6",
                    "date_from": 1517492965,
                    "date_to": 1519912165,
                    "description": "basic USD",
                    "discount_amount": 0,
                    "entity_id": "basic-USD",
                    "entity_type": "plan_item_price",
                    "id": "li___test__8asyKSOcecDPPF",
                    "is_taxed": false,
                    "item_level_discount_amount": 0,
                    "object": "line_item",
                    "pricing_model": "per_unit",
                    "quantity": 1,
                    "subscription_id": "__test__8asyKSOcecBvPD",
                    "tax_amount": 0,
                    "unit_amount": 1000
                },
                {..}
            ],
            "object": "invoice_estimate",
            "price_type": "tax_exclusive",
            "recurring": true,
            "round_off_amount": 0,
            "sub_total": 2000,
            "taxes": [],
            "total": 2000
        },
        {..}
    ],
    "object": "estimate"
}}

URL Format GET

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

estimate

Resource object representing estimate.
always returned

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__8asyKSOceZF8N6/change_term_end_estimate \
     -u {site_api_key}:\
     -d term_ends_at=1566697500

copy

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

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517492954,
    "credit_note_estimates": [],
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__8asyKSOceZF8N6",
        "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

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

prorate

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

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.

.
optional, boolean

estimate

Resource object representing estimate.
always returned

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8ass3SIVLJaId/cancel_subscription_for_items_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d credit_option_for_current_term_charges="prorate" \
     -d end_of_term="false"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8ass3SIVLJaId/cancel_subscription_for_items_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d credit_option_for_current_term_charges="prorate" \
     -d end_of_term="false"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1612964956,
    "credit_note_estimates": [
        {
            "amount_allocated": 1100,
            "amount_available": 0,
            "currency_code": "USD",
            "customer_id": "__test__8asyKSOceZlINV",
            "line_item_discounts": [],
            "line_item_taxes": [],
            "line_items": [
                {
                    "amount": 1000,
                    "customer_id": "__test__8asyKSOceZlINV",
                    "date_from": 1612964956,
                    "date_to": 1615384155,
                    "description": "basic USD - Prorated Credits for 10-Feb-2021 - 10-Mar-2021",
                    "discount_amount": 0,
                    "entity_id": "basic-USD",
                    "entity_type": "plan_item_price",
                    "id": "li___test__8asyKSOceZyANi",
                    "is_taxed": false,
                    "item_level_discount_amount": 0,
                    "object": "line_item",
                    "pricing_model": "per_unit",
                    "quantity": 1,
                    "subscription_id": "__test__8asyKSOceZpONY",
                    "tax_amount": 0,
                    "unit_amount": 1000
                },
                {..}
            ],
            "object": "credit_note_estimate",
            "price_type": "tax_exclusive",
            "reference_invoice_id": "__demo_inv__4",
            "round_off_amount": 0,
            "sub_total": 1100,
            "taxes": [],
            "total": 1100,
            "type": "adjustment"
        },
        {..}
    ],
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__8asyKSOceZpONY",
        "object": "subscription_estimate",
        "status": "cancelled"
    }
}}

URL Format POST

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

end_of_term

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

cancel_at

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.

.
optional, timestamp(UTC) in seconds

credit_option_for_current_term_charges

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

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

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

Possible values are

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

account_receivables_handling

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.
optional, enumerated string

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

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.
optional, enumerated string

Possible values are

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

contract_term_cancel_option

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.

.
optional, enumerated string

Possible values are

terminate_immediatelyTerminate immediately.end_of_contract_termEnd of contract term.

invoice_date

The document date displayed on the invoice PDF. 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. When not provided, the date is the same as cancel_at. 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 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.

.
optional, timestamp(UTC) in seconds

cancel_reason_code

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.
optional, string, max chars=100

subscription_items

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

subscription_items[item_price_id][0..n]

The unique id of the charge item_price that represents the termination fee.
optional, string, max chars=100

subscription_items[quantity][0..n]

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

subscription_items[quantity_in_decimal][0..n]

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

subscription_items[unit_price][0..n]

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

subscription_items[unit_price_in_decimal][0..n]

subscription_items[service_period_days][0..n]

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

estimate

Resource object representing estimate.
always returned

This API provides an estimate of the details pertaining to the pause_subscription operation. It returns attributes such as pause_date, resume_date, etc. This is similar to the Pause a subscription API, but the subscription will not be 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 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.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asyKSOcebl8Oi/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__8asyKSOcebl8Oi/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": 1517492963,
    "credit_note_estimates": [],
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__8asyKSOcebl8Oi",
        "next_billing_at": 1519912163,
        "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

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

Possible values are

immediatelyPause immediately.end_of_termPause at the end of current term.specific_datePause on a specific date.

unbilled_charges_handling

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

Possible values are

no_actionRetain as unbilled.invoiceInvoice charges.

subscription

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

subscription[pause_date]

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.
optional, timestamp(UTC) in seconds

subscription[resume_date]

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.
optional, timestamp(UTC) in seconds

estimate

Resource object representing estimate.
always returned

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__8asyKSOcebwWOw/resume_subscription_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d resume_option="immediately"

copy

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

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517492964,
    "next_invoice_estimate": {
        "amount_due": 2000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8asyKSOcebrPOp",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__8asyKSOcebrPOp",
                "date_from": 1517492964,
                "date_to": 1519912164,
                "description": "basic USD",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "li___test__8asyKSOcebyEOy",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "subscription_id": "__test__8asyKSOcebwWOw",
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 2000,
        "taxes": [],
        "total": 2000
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__8asyKSOcebwWOw",
        "next_billing_at": 1519912164,
        "object": "subscription_estimate",
        "status": "active"
    }
}}

URL Format POST

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

resume_option

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

Possible values are

immediatelyResume immediately.specific_dateResume on a specific date.

charges_handling

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.
optional, enumerated string

Possible values are

invoice_immediatelyInvoice immediately.add_to_unbilled_chargesAdd to unbilled charges.

subscription

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

subscription[resume_date]

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.
optional, timestamp(UTC) in seconds

estimate

Resource object representing estimate.
always returned

Sample Request

curl  https://{site}.chargebee.com/api/v2/estimates/gift_subscription_for_items \
     -u {site_api_key}:\
     -d gift[scheduled_at]=1601106050 \
     -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" \
     -d subscription_items[item_price_id][0]="gift-plan-USD" \
     -d subscription_items[quantity][0]=2 \
     -d subscription_items[item_price_id][1]="day-pass-USD"

copy

curl  https://{site}.chargebee.com/api/v2/estimates/gift_subscription_for_items \
     -u {site_api_key}:\
     -d gift[scheduled_at]=1601106050 \
     -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" \
     -d subscription_items[item_price_id][0]="gift-plan-USD" \
     -d subscription_items[quantity][0]=2 \
     -d subscription_items[item_price_id][1]="day-pass-USD"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1612964962,
    "invoice_estimate": {
        "amount_due": 2000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "gifter",
        "date": 1612964962,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 2000,
                "customer_id": "gifter",
                "date_from": 1708177762,
                "date_to": 1710683362,
                "description": "Gift Plan USD",
                "discount_amount": 0,
                "entity_id": "gift-plan-USD",
                "entity_type": "plan_item_price",
                "id": "li___test__8asyKSOcebcQOY",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 2,
                "subscription_id": "__test__8asyKSOcebZjOW",
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": true,
        "round_off_amount": 0,
        "sub_total": 2000,
        "taxes": [],
        "total": 2000
    },
    "object": "estimate",
    "subscription_estimate": {
        "currency_code": "USD",
        "id": "__test__8asyKSOcebZjOW",
        "object": "subscription_estimate",
        "status": "future"
    }
}}

URL Format POST

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

coupon_ids[0..n]

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

gift

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

gift[scheduled_at]

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

gift[auto_claim]

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

gift[no_expiry]

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

gift[claim_expiry_date]

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.
optional, timestamp(UTC) in seconds

gifter

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

gifter[customer_id]

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

gifter[signature]

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

gifter[note]

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

gifter[payment_src_id]

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

gift_receiver

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

gift_receiver[customer_id]

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

gift_receiver[first_name]

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

gift_receiver[last_name]

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

gift_receiver[email]

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

payment_intent

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

payment_intent[id]

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.
optional, string, max chars=150

payment_intent[gateway_account_id]

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

payment_intent[gw_token]

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.
optional, string, max chars=65k

payment_intent[reference_id]

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

payment_intent[additional_information]

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.

.
optional, jsonobject

shipping_address

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

shipping_address[first_name]

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

shipping_address[last_name]

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

shipping_address[email]

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

shipping_address[company]

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

shipping_address[phone]

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

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

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

shipping_address[state_code]

shipping_address[state]

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

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

shipping_address[validation_status]

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

subscription_items

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

subscription_items[item_price_id][0..n]

The unique identifier of the item price.
optional, string, max chars=100

subscription_items[quantity][0..n]

The quantity of the item purchased.
optional, integer, default=1, min=1

subscription_items[quantity_in_decimal][0..n]

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

estimate

Resource object representing estimate.
always returned

Sample Request

curl  https://{site}.chargebee.com/api/v2/estimates/create_invoice_for_items \
     -u {site_api_key}:\
     -d invoice[customer_id]="__test__KyVkjTS2onpk57" \
     -d item_prices[item_price_id][0]="ssl-charge-USD" \
     -d item_prices[unit_price][0]=2000 \
     -d charges[amount][0]=1000 \
     -d charges[description][0]="Adhoc charge"

copy

curl  https://{site}.chargebee.com/api/v2/estimates/create_invoice_for_items \
     -u {site_api_key}:\
     -d invoice[customer_id]="__test__KyVkjTS2onpk57" \
     -d item_prices[item_price_id][0]="ssl-charge-USD" \
     -d item_prices[unit_price][0]=2000 \
     -d charges[amount][0]=1000 \
     -d charges[description][0]="Adhoc charge"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1517492957,
    "invoice_estimate": {
        "amount_due": 3000,
        "amount_paid": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8asyKSOcea8tNt",
        "date": 1517492957,
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 2000,
                "customer_id": "__test__8asyKSOcea8tNt",
                "date_from": 1517492957,
                "date_to": 1517492957,
                "description": "SSL Charge USD Monthly",
                "discount_amount": 0,
                "entity_id": "ssl-charge-USD",
                "entity_type": "charge_item_price",
                "id": "li___test__8asyKSOceaEYNx",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 2000
            },
            {..}
        ],
        "object": "invoice_estimate",
        "price_type": "tax_exclusive",
        "recurring": false,
        "round_off_amount": 0,
        "sub_total": 3000,
        "taxes": [],
        "total": 3000
    },
    "object": "estimate"
}}

URL Format POST

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

currency_code

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

invoice_note

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

remove_general_note

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

coupon_ids[0..n]

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

authorization_transaction_id

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

payment_source_id

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

auto_collection

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

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]

Identifier of the customer for which this invoice needs to be created.
required, string, max chars=50

invoice[subscription_id]

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).
optional, string, max chars=50

invoice[po_number]

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

shipping_address

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

shipping_address[first_name]

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

shipping_address[last_name]

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

shipping_address[email]

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

shipping_address[company]

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

shipping_address[phone]

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

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

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

shipping_address[state_code]

shipping_address[state]

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

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

shipping_address[validation_status]

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

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

item_prices

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

item_prices[item_price_id][0..n]

A unique ID for your system to identify the item price.
optional, string, max chars=100

item_prices[quantity][0..n]

Item price quantity.
optional, integer, min=1

item_prices[quantity_in_decimal][0..n]

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

item_prices[unit_price][0..n]

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

item_prices[unit_price_in_decimal][0..n]

The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
optional, string, max chars=33

item_prices[date_from][0..n]

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

item_prices[date_to][0..n]

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

item_tiers

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

item_tiers[item_price_id][0..n]

The id of the item price to which this tier belongs.
optional, string, max chars=100

item_tiers[starting_unit][0..n]

The lowest value in the quantity tier.
optional, integer, min=1

item_tiers[ending_unit][0..n]

The highest value in the quantity tier.
optional, integer

item_tiers[price][0..n]

The per-unit price for the tier when the pricing_model is tiered or volume. The total cost for the item price when the pricing_model is stairstep. The value is in the minor unit of the currency.
optional, in cents, default=0, min=0

item_tiers[starting_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[ending_unit_in_decimal][0..n]

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 pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
optional, string, max chars=33

item_tiers[price_in_decimal][0..n]

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 the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
optional, string, max chars=33

charges

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

charges[discount_amount][0..n]

The value of the discount. The format of this value depends on the kind of currency. Either this parameter or charges[discount_percentage] should be passed.
optional, in cents, min=0

charges[discount_percentage][0..n]

The percentage of the original amount that should be deducted from it. Either this parameter or charges[discount_amount] should be passed.
optional, double, min=0.01, max=100.0

charges[amount][0..n]

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

charges[amount_in_decimal][0..n]

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.
optional, string, max chars=33

charges[description][0..n]

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

charges[taxable][0..n]

optional, boolean, default=true

charges[tax_profile_id][0..n]

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

charges[avalara_tax_code][0..n]

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.
optional, string, max chars=50

charges[taxjar_product_code][0..n]

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

charges[avalara_sale_type][0..n]

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

Possible values are

wholesaleTransaction is a sale to another company that will resell your product or service to another consumer.retailTransaction is a sale to an end user.consumedTransaction is for an item that is consumed directly.vendor_useTransaction is for an item that is subject to vendor use tax.

charges[avalara_transaction_type][0..n]

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.
optional, integer

charges[avalara_service_type][0..n]

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.
optional, integer

charges[date_from][0..n]

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

charges[date_to][0..n]

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

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]

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

Possible values are

customerEntity that represents a customer.subscriptionEntity that represents a subscription of customer.couponEntity that represents a coupon.plan_item_priceIndicates that this line item is based on plan Item Price.addon_item_priceIndicates that this line item is based on addon Item Price.charge_item_priceIndicates that this line item is based on charge Item Price.

notes_to_remove[entity_id][0..n]

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

discounts

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

discounts[percentage][0..n]

The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
optional, double, min=0.01, max=100.0

discounts[amount][0..n]

The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
optional, in cents, min=0

discounts[apply_on][0..n]

The amount on the invoice to which the discount is applied.
required, enumerated string

Possible values are

discounts[item_price_id][0..n]

The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
optional, string, max chars=100

estimate

Resource object representing estimate.
always returned

Sample estimate [ JSON ]

Estimate attributes

Subscription estimate attributes

Invoice estimate attributes

Credit note estimate attributes

Unbilled charge estimate attributes

Estimate for creating a customer and subscription¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Estimate for creating a subscription¶

Notes

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Estimate for updating a subscription¶

Notes

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Subscription renewal estimate¶

Sample Response [ JSON ]

URL Format GET

Input Parameters

Returns

Advance invoice estimate¶

URL Format POST

Input Parameters

Returns

Regenerate Invoice Estimate¶

Response

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 for items 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 for items¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Create invoice for items estimate¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns