Settings
API Version
Product Catalog
Library

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" } }

API Index URL

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

Model Class

 

      Estimate attributes
      
   
created_at created_at
 

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

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

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

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

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

          optional, list of payment_schedule_estimate
 payment_schedule_estimate is used to hold the details related   to payment schedules for an invoice. It will contain a list of payment_schedules resources. 
 
next_invoice_estimate 
 

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

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

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

          Subscription Estimate attributes
          
 
resume_date
 

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

      resume_date
 Show attributes [+]
 
 optional, timestamp(UTC) in seconds
 The date on which subscription will be resumed. Applicable only to paused or scheduled pause subscriptions
 
 
pause_date
 

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

      pause_date
 Show attributes [+]
 
 optional, timestamp(UTC) in seconds
 The date on which subscription will be paused. Applicable only to paused or scheduled pause subscriptions
 
 
next_billing_at
 

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

      next_billing_at
 Show attributes [+]
 
 optional, timestamp(UTC) in seconds
 Date on which the next billing happens. This will be null for non-renewing and cancelled subscriptions.
 
 
trial_end_action
 

      optional, enumerated string
 Applicable only when End-of-trial Action has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. 
 
Possible values are
 
 
site_defaultThis is the default value. The action configured for the site at the time when the trial ends, takes effect.plan_defaultThe action configured for the site at the time when the trial ends, takes effect.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
 
 Show all values[+]
 

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

      optional, enumerated string
 The status of the subscription. 
 
Possible values are
 
 
futureThe subscription is scheduled to start at a future date.in_trialThe subscription is in trial.activeThe subscription is active and will be charged for automatically based on the items in it.non_renewingThe subscription will be canceled at the end of the current term.
 
 Show all values[+]
 

      status
 Show attributes [+]
 
 optional, enumerated string
 The status of the subscription.
 
 
currency_code
 

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

      currency_code
 Show attributes [+]
 
 required, string, max chars=3
 The currency code (ISO 4217 format) of the subscription.
 
 
id
 

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

      id
 Show attributes [+]
 
 optional, string, max chars=50
 The identifier of the subscription
 
 
shipping_address
 

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

      shipping_address
 Show attributes [+]
 
 optional, shipping_address
 Represents the shipping address when the 'estimate' operations are invoked.
 
 
contract_term
 

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

      contract_term
 Show attributes [+]
 
 optional, contract_term
 Represents the contract terms when the 'estimate' operations are invoked.
 
 

          Invoice Estimate attributes
          
 
customer_id
 

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

      customer_id
 Show attributes [+]
 
 optional, string, max chars=100
 A unique identifier for the customer this invoice belongs to
 
 
round_off_amount
 

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

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

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

      amount_due
 Show attributes [+]
 
 optional, in cents, default=0, min=0
 Invoice amount due in cents
 
 
amount_paid
 

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

      amount_paid
 Show attributes [+]
 
 optional, in cents, default=0, min=0
 Existing outstanding payments if any, applied to this invoice in cents.
 
 
credits_applied
 

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

      credits_applied
 Show attributes [+]
 
 optional, in cents, default=0, min=0
 credits applied to this invoice in cents.
 
 
total
 

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

      total
 Show attributes [+]
 
 optional, in cents, default=0, min=0
 Invoice total in cents.
 
 
sub_total
 

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

      sub_total
 Show attributes [+]
 
 required, in cents, min=0
 Invoice sub-total in cents.
 
 
currency_code
 

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

      currency_code
 Show attributes [+]
 
 required, string, max chars=3
 The currency code (ISO 4217 format) of the invoice.
 
 
price_type
 

      enumerated string, default=tax_exclusive
 The price type of this invoice. 
 
Possible values are
 
 
tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.
 
 Show all values[+]
 

      price_type
 Show attributes [+]
 
 required, enumerated string, default=tax_exclusive
 The price type of this invoice.
 
 
recurring
 

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

      recurring
 Show attributes [+]
 
 required, boolean, default=true
 Whether or not the estimate for the invoice is recurring. Will be 'true' or 'false' for subscription related estimates.
 
 
line_items
 

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


    
Note

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

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


 
 
 

      line_items
 Show attributes [+]
 
 optional, list of line_item
 The details of the line items in this invoice estimate.


    
Note

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

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


 
 
line_item_tiers
 

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

      line_item_tiers
 Show attributes [+]
 
 optional, list of line_item_tier
 The list of tiers applicable for this line item
 
 
line_item_discounts
 

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

      line_item_discounts
 Show attributes [+]
 
 optional, list of line_item_discount
 The list of discount(s) applied for each line item of this invoice.
 
 
line_item_taxes
 

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

      line_item_taxes
 Show attributes [+]
 
 optional, list of line_item_tax
 The list of taxes applied on line items
 
 
line_item_credits
 

      optional, list of line_item_credit
 A list of store credits applied to line items. 
 
 

      line_item_credits
 Show attributes [+]
 
 optional, list of line_item_credit
 A list of store credits applied to line items.
 
 
line_item_addresses
 

      optional, list of line_item_address
 The list of addresses used for tax calculation on line items. 
 
 

      line_item_addresses
 Show attributes [+]
 
 optional, list of line_item_address
 The list of addresses used for tax calculation on line items.
 
 
discounts
 

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

      discounts
 Show attributes [+]
 
 optional, list of discount
 The list of discounts applied to this estimate
 
 
taxes
 

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

      taxes
 Show attributes [+]
 
 optional, list of tax
 The list of taxes applied to this estimate
 
 

          Payment Schedule Estimate attributes
          
 
currency_code
 

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

      currency_code
 Show attributes [+]
 
 optional, string, max chars=3
 The currency code (ISO 4217 format) of the transaction amount.
 
 
amount
 

      in cents, min=0
 An amount that this payment schedule is able to collect. 
 
 

      amount
 Show attributes [+]
 
 required, in cents, min=0
 An amount that this payment schedule is able to collect.
 
 
entity_id
 

      optional, string, max chars=50
 The identifier of the modeled entity that this payment schedule is based on. 
 
 

      entity_id
 Show attributes [+]
 
 optional, string, max chars=50
 The identifier of the modeled entity that this payment schedule is based on.
 
 
entity_type
 

      enumerated string
 Specifies the modeled entity that the payment schedule is based on. 
 
Possible values are
 
 
invoiceRepresents an invoice.
 
 Show all values[+]
 

      entity_type
 Show attributes [+]
 
 required, enumerated string
 Specifies the modeled entity that the payment schedule is based on.
 
 
scheme_id
 

      string, max chars=40
 The identifier of the payment_schedule_scheme, used to create the payment schedules. 
 
 

      scheme_id
 Show attributes [+]
 
 required, string, max chars=40
 The identifier of the payment_schedule_scheme, used to create the payment schedules.
 
 
id
 

      string, max chars=40
 An auto-generated unique identifier for the payment schedule. 
 
 

      id
 Show attributes [+]
 
 required, string, max chars=40
 An auto-generated unique identifier for the payment schedule.
 
 
schedule_entries
 

      optional, list of schedule_entry
 List of schedule entries 
 
 

      schedule_entries
 Show attributes [+]
 
 optional, list of schedule_entry
 List of schedule entries
 
 

          Credit Note Estimate attributes
          
 
customer_id
 

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

      customer_id
 Show attributes [+]
 
 optional, string, max chars=100
 A unique identifier for the customer this credit note belongs to
 
 
round_off_amount
 

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

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

      in cents, min=0
 Remaining credits in cents 
 
 

      amount_available
 Show attributes [+]
 
 required, in cents, min=0
 Remaining credits in cents
 
 
amount_allocated
 

      in cents, min=0
 Allocated credits in cents. 
 
 

      amount_allocated
 Show attributes [+]
 
 required, in cents, min=0
 Allocated credits in cents.
 
 
total
 

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

      total
 Show attributes [+]
 
 required, in cents, min=0
 Credit note total in cents.
 
 
sub_total
 

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

      sub_total
 Show attributes [+]
 
 required, in cents, min=0
 Invoice sub-total in cents.
 
 
currency_code
 

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

      currency_code
 Show attributes [+]
 
 required, string, max chars=3
 The currency code (ISO 4217 format) of the credit note.
 
 
price_type
 

      enumerated string, default=tax_exclusive
 The price type of this credit note. 
 
Possible values are
 
 
tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.
 
 Show all values[+]
 

      price_type
 Show attributes [+]
 
 required, enumerated string, default=tax_exclusive
 The price type of this credit note.
 
 
type
 

      enumerated string
 Credit note types. Learn more about credit note types. 
 
Possible values are
 
 
adjustmentAdjustment Credit NoterefundableRefundable Credit NotestoreStore Credit Note
 
 Show all values[+]
 

      type
 Show attributes [+]
 
 required, enumerated string
 Credit note types. Learn more about credit note types.
 
 
reference_invoice_id
 

      string, max chars=50
 The reference invoice id 
 
 

      reference_invoice_id
 Show attributes [+]
 
 required, string, max chars=50
 The reference invoice id
 
 
line_items
 

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

      line_items
 Show attributes [+]
 
 optional, list of line_item
 The list of items in this estimate
 
 
line_item_tiers
 

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

      line_item_tiers
 Show attributes [+]
 
 optional, list of line_item_tier
 The list of tiers applicable for this line item
 
 
line_item_discounts
 

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

      line_item_discounts
 Show attributes [+]
 
 optional, list of line_item_discount
 The list of discount(s) applied for each line item of this invoice.
 
 
line_item_taxes
 

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

      line_item_taxes
 Show attributes [+]
 
 optional, list of line_item_tax
 The list of taxes applied on line items
 
 
discounts
 

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

      discounts
 Show attributes [+]
 
 optional, list of discount
 The list of discounts applied to this estimate
 
 
taxes
 

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

      taxes
 Show attributes [+]
 
 optional, list of tax
 The list of taxes applied to this estimate
 
 

          Unbilled Charge Estimate attributes
          
 
deleted
 

      boolean
 Indicates that this resource has been deleted. 
 
 

      deleted
 Show attributes [+]
 
 required, boolean
 Indicates that this resource has been deleted.
 
 
business_entity_id
 

      optional, string, max chars=50
 The unique ID of the 
business entity of this subscription. This is always the same as the 
business entity of the customer. 
 
 
 

      business_entity_id
 Show attributes [+]
 
 optional, string, max chars=50
 The unique ID of the 
business entity of this subscription. This is always the same as the 
business entity of the customer. 

 
 
is_advance_charge
 

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

      is_advance_charge
 Show attributes [+]
 
 optional, boolean, default=false
 The value of this parameter will be true if it is a recurring unbilled charge for a future term.
 
 
updated_at
 

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

      updated_at
 Show attributes [+]
 
 required, timestamp(UTC) in seconds
 Timestamp indicating when the unbilled charge was last updated
 
 
amount_in_decimal
 

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

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

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

      quantity_in_decimal
 Show attributes [+]
 
 optional, string, max chars=33
 The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and multi-decimal pricing  is enabled.
 
 
unit_amount_in_decimal
 

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

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

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

      voided_at
 Show attributes [+]
 
 optional, timestamp(UTC) in seconds
 Timestamp indicating the date and time this charge got voided.
 
 
is_voided
 

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

      is_voided
 Show attributes [+]
 
 required, boolean, default=false
 Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
 
 
entity_id
 

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

      entity_id
 Show attributes [+]
 
 optional, string, max chars=100
  The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
 
 
entity_type
 

      enumerated string
 Specifies the modelled entity this line item is based on. 
 
Possible values are
 
 
adhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this caseplan_item_priceIndicates that this line item is based on plan Item Priceaddon_item_priceIndicates that this line item is based on addon Item Pricecharge_item_priceIndicates that this line item is based on charge Item Price
 
 Show all values[+]
 

      entity_type
 Show attributes [+]
 
 required, enumerated string
 Specifies the modelled entity this line item is based on.
 
 
description
 

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

      description
 Show attributes [+]
 
 optional, string, max chars=250
 Detailed description about this charge.
 
 
discount_amount
 

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

      discount_amount
 Show attributes [+]
 
 optional, in cents, min=0
 Total discounts for this charge.
 
 
currency_code
 

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

      currency_code
 Show attributes [+]
 
 required, string, max chars=3
 The currency code (ISO 4217 format) for the charge.
 
 
amount
 

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

      amount
 Show attributes [+]
 
 optional, in cents, min=0
 Total amount of this charge. Typically equals to unit amount x quantity.
 
 
quantity
 

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

      quantity
 Show attributes [+]
 
 optional, integer, min=0
 Quantity of the item which is represented by this charge.
 
 
pricing_model
 

      optional, enumerated string
 The pricing scheme for this line item. 
 
Possible values are
 
 
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.volumeThe per unit price is based on the tier that the total quantity falls in.
 
 Show all values[+]
 

      pricing_model
 Show attributes [+]
 
 optional, enumerated string
 The pricing scheme for this line item.
 
 
unit_amount
 

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

      unit_amount
 Show attributes [+]
 
 optional, in cents, min=0
 Unit amount of the charge item.
 
 
date_to
 

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

      date_to
 Show attributes [+]
 
 optional, timestamp(UTC) in seconds
 End date of this charge.
 
 
date_from
 

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

      date_from
 Show attributes [+]
 
 optional, timestamp(UTC) in seconds
 Start date of this charge.
 
 
subscription_id
 

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

      subscription_id
 Show attributes [+]
 
 optional, string, max chars=50
 A unique identifier for the subscription this charge belongs to.
 
 
customer_id
 

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

      customer_id
 Show attributes [+]
 
 optional, string, max chars=50
 A unique identifier for the customer being charged.
 
 
id
 

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

      id
 Show attributes [+]
 
 optional, string, max chars=40
 Uniquely identifies an unbilled charge.
 
 
tiers
 

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

      tiers
 Show attributes [+]
 
 optional, list of line_item_tier
 The list of tiers applicable for this line item
 
 
 
Consent Fields for Estimate
 
 
Custom Fields for Estimate
 
 

      Estimate for creating a customer and subscription
      
  
 
  Try in API Explorer
   
 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. 
    •  

 

  
Notes
 
 

        Sample Request
      
 

  Try in API Explorer

 
 
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 "customer[taxability]"="TAXABLE" \
     -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 
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 "customer[taxability]"="EXEMPT" \
     -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 
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" 
curl  https://{site}.chargebee.com/api/v2/estimates/create_subscription_for_items \
     -u {site_api_key}:\
     -d invoice_immediately=false \
     -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 
 

      copy
      
Click to Copy
 
 
 
 
200:
 
OK
 
STATUS
 

    Sample Response [ JSON ]
 
Show more...
 
{
    "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"
        }
    }
}
 

      URL Format
      POST
 

      https://{site}.chargebee.com/api/v2/estimates/create_subscription_for_items
    
 
Method
 
 
Input Parameters
 
  
 
billing_cycles[]
 

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

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

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

      optional, enumerated string 
 Override the  billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site. 
Possible values are
 
 
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
 
 Show all values[+]
 
coupon_ids[[0..n]][0..n]
 

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

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


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

. 
 
invoice_date[]
 

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

      optional, string, max chars=50 
 Indicates the Client profile id for the customer. This is applicable only if you use Chargebee’s AvaTax for Communications integration. 
 
 
 
 
 
subscription[id]
 
optional, string, max chars=50 
  
subscription[trial_end]
 
optional, timestamp(UTC) in seconds 
  
subscription[start_date]
 
optional, timestamp(UTC) in seconds 
  
subscription[offline_payment_method]
 
optional, enumerated string 
  
Possible values are
 
 
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer
 
 Show all values[+]
subscription[free_period]
 
optional, integer, min=1 
  
subscription[free_period_unit]
 
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)
 
 Show all values[+]
subscription[contract_term_billing_cycle_on_renewal]
 
optional, integer, min=1, max=100 
  
subscription[trial_end_action]
 
optional, enumerated string 
  
Possible values are
 
 
site_defaultThis is the default value. The action configured for the site at the time when the trial ends, takes effect.plan_defaultThe action configured for the site at the time when the trial ends, takes effect.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
 
 Show all values[+]
 
 
billing_address[line1]
 
optional, string, max chars=150 
  
billing_address[line2]
 
optional, string, max chars=150 
  
billing_address[line3]
 
optional, string, max chars=150 
  
billing_address[city]
 
optional, string, max chars=50 
  
billing_address[state_code]
 
optional, string, max chars=50 
  
billing_address[zip]
 
optional, string, max chars=20 
  
billing_address[country]
 
optional, string, max chars=50 
  
billing_address[validation_status]
 
optional, enumerated string, default=not_validated 
  
Possible values are
 
 
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
 
 Show all values[+]
 
 
shipping_address[line1]
 
optional, string, max chars=150 
  
shipping_address[line2]
 
optional, string, max chars=150 
  
shipping_address[line3]
 
optional, string, max chars=150 
  
shipping_address[city]
 
optional, string, max chars=50 
  
shipping_address[state_code]
 
optional, string, max chars=50 
  
shipping_address[zip]
 
optional, string, max chars=20 
  
shipping_address[country]
 
optional, string, max chars=50 
  
shipping_address[validation_status]
 
optional, enumerated string, default=not_validated 
  
Possible values are
 
 
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
 
 Show all values[+]
 
 
customer[vat_number]
 
optional, string, max chars=20 
  
customer[vat_number_prefix]
 
optional, string, max chars=10 
  
customer[registered_for_gst]
 
optional, boolean 
  
customer[taxability]
 
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.
 
 Show all values[+]
customer[entity_code]
 
optional, enumerated string 
  
Possible values are
 
 
aFederal governmentbState governmentcTribe/Status Indian/Indian BanddForeign diplomat
 
 Show all values[+]
customer[exempt_number]
 
optional, string, max chars=100 
  
customer[exemption_details]
 
optional 
  
customer[customer_type]
 
optional, enumerated string 
  
Possible values are
 
 
residentialWhen the purchase is made by a customer for home usebusinessWhen the purchase is made at a place of businesssenior_citizenWhen the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaksindustrialWhen the purchase is made by an industrial business
 
 Show all values[+]
 
 
contract_term[action_at_term_end]
 
optional, enumerated string 
  
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.
     
     Show all values[+]
    contract_term[cancellation_cutoff_period]
     
    optional, integer, default=0 
      
     
     
    subscription_items[item_price_id][0..n]
     
    required, string, max chars=100 
      
    subscription_items[quantity][0..n]
     
    optional, integer, min=1 
      
    subscription_items[quantity_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    subscription_items[unit_price][0..n]
     
    optional, in cents, min=0 
      
    subscription_items[unit_price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    subscription_items[billing_cycles][0..n]
     
    optional, integer, min=0 
      
    subscription_items[trial_end][0..n]
     
    optional, timestamp(UTC) in seconds 
      
    subscription_items[service_period_days][0..n]
     
    optional, integer, min=1, max=730 
      
    subscription_items[charge_on_event][0..n]
     
    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.
     
     Show all values[+]
    subscription_items[charge_once][0..n]
     
    optional, boolean 
      
    subscription_items[charge_on_option][0..n]
     
    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.
     
     Show all values[+]
     
     
    discounts[apply_on][0..n]
     
    optional, 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.
     
     Show all values[+]
    discounts[duration_type][0..n]
     
    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.
     
     Show all values[+]
    discounts[percentage][0..n]
     
    optional, double, min=0.01, max=100.0 
      
    discounts[amount][0..n]
     
    optional, in cents, min=0 
      
    discounts[period][0..n]
     
    optional, integer, min=1 
      
    discounts[period_unit][0..n]
     
    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.
     
     Show all values[+]
    discounts[included_in_mrr][0..n]
     
    optional, boolean 
      
    discounts[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    discounts[quantity][0..n]
     
    optional, integer, min=1 
      
     
     
    item_tiers[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    item_tiers[starting_unit][0..n]
     
    optional, integer, min=1 
      
    item_tiers[ending_unit][0..n]
     
    optional, integer 
      
    item_tiers[price][0..n]
     
    optional, in cents, default=0, min=0 
      
    item_tiers[starting_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[ending_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    item_tiers[pricing_type][0..n]
     
    optional, enumerated string 
      
    Possible values are
     
     
    per_unitIndicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).flat_feeIndicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep pricing model, pricing_type will be set to flat_fee by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.packageIndicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
     
     Show all values[+]
    item_tiers[package_size][0..n]
     
    optional, integer, min=1 
      
     
     
    tax_providers_fields[provider_name][0..n]
     
    optional, string, max chars=50 
      
    tax_providers_fields[field_id][0..n]
     
    optional, string, max chars=50 
      
    tax_providers_fields[field_value][0..n]
     
    optional, string, max chars=50 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Estimate for creating a subscription
      
      
     
  Try in API Explorer
   
     Generates an estimate without creating a subscription. This endpoint can be called when you want to preview details of a new subscription before actually creating one. 
      
    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
      
     
    
  Try in API Explorer

     
     
    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
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    use_existing_balances[]
     
    
      optional, boolean, default=true 
     The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don’t want these balances to be included you can specify 'false' for the parameter use_existing_balances. 
     
    invoice_immediately[]
     
    
      optional, boolean 
     If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.

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

    .     
     
    billing_cycles[]
     
    
      optional, integer, min=0 
     The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan-item price is used. 
     
    mandatory_items_to_remove[[0..n]][0..n]
     
    
      optional, list of string 
     Item ids of mandatorily attached addons that are to be removed from the subscription. 
     
    terms_to_charge[]
     
    
      optional, integer, min=1 
     The number of subscription billing cycles (including the first one) to invoice in advance. 
     
    billing_alignment_mode[]
     
    
      optional, enumerated string 
     Override the  billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site. 
    Possible values are
     
     
    immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
     
     Show all values[+]
     
    invoice_date[]
     
    
      optional, timestamp(UTC) in seconds 
     The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
taxes and
line_item_taxes are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December. 
     
    coupon_ids[[0..n]][0..n]
     
    
      optional, list of string 
     List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes. 
     
     
     
     
     
    subscription[id]
     
    optional, string, max chars=50 
      
    subscription[trial_end]
     
    optional, timestamp(UTC) in seconds 
      
    subscription[start_date]
     
    optional, timestamp(UTC) in seconds 
      
    subscription[offline_payment_method]
     
    optional, enumerated string 
      
    Possible values are
     
     
    no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer
     
     Show all values[+]
    subscription[free_period]
     
    optional, integer, min=1 
      
    subscription[free_period_unit]
     
    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)
     
     Show all values[+]
    subscription[contract_term_billing_cycle_on_renewal]
     
    optional, integer, min=1, max=100 
      
    subscription[trial_end_action]
     
    optional, enumerated string 
      
    Possible values are
     
     
    site_defaultThis is the default value. The action configured for the site at the time when the trial ends, takes effect.plan_defaultThe action configured for the site at the time when the trial ends, takes effect.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
     
     Show all values[+]
     
     
    shipping_address[line1]
     
    optional, string, max chars=150 
      
    shipping_address[line2]
     
    optional, string, max chars=150 
      
    shipping_address[line3]
     
    optional, string, max chars=150 
      
    shipping_address[city]
     
    optional, string, max chars=50 
      
    shipping_address[state_code]
     
    optional, string, max chars=50 
      
    shipping_address[zip]
     
    optional, string, max chars=20 
      
    shipping_address[country]
     
    optional, string, max chars=50 
      
    shipping_address[validation_status]
     
    optional, enumerated string, default=not_validated 
      
    Possible values are
     
     
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
     
     Show all values[+]
     
     
    billing_address[line1]
     
    optional, string, max chars=150 
      
    billing_address[line2]
     
    optional, string, max chars=150 
      
    billing_address[line3]
     
    optional, string, max chars=150 
      
    billing_address[city]
     
    optional, string, max chars=50 
      
    billing_address[state_code]
     
    optional, string, max chars=50 
      
    billing_address[zip]
     
    optional, string, max chars=20 
      
    billing_address[country]
     
    optional, string, max chars=50 
      
    billing_address[validation_status]
     
    optional, enumerated string, default=not_validated 
      
    Possible values are
     
     
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
     
     Show all values[+]
     
     
    contract_term[action_at_term_end]
     
    optional, enumerated string 
      
    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.
     
     Show all values[+]
    contract_term[cancellation_cutoff_period]
     
    optional, integer, default=0 
      
     
     
    billing_override[max_excess_payment_usage]
     
    optional, long, min=-1 
      
    billing_override[max_refundable_credits_usage]
     
    optional, long, min=-1 
      
     
     
    subscription_items[item_price_id][0..n]
     
    required, string, max chars=100 
      
    subscription_items[quantity][0..n]
     
    optional, integer, min=1 
      
    subscription_items[quantity_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    subscription_items[unit_price][0..n]
     
    optional, in cents, min=0 
      
    subscription_items[unit_price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    subscription_items[billing_cycles][0..n]
     
    optional, integer, min=0 
      
    subscription_items[trial_end][0..n]
     
    optional, timestamp(UTC) in seconds 
      
    subscription_items[service_period_days][0..n]
     
    optional, integer, min=1, max=730 
      
    subscription_items[charge_on_event][0..n]
     
    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.
     
     Show all values[+]
    subscription_items[charge_once][0..n]
     
    optional, boolean 
      
    subscription_items[charge_on_option][0..n]
     
    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.
     
     Show all values[+]
     
     
    discounts[apply_on][0..n]
     
    optional, 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.
     
     Show all values[+]
    discounts[duration_type][0..n]
     
    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.
     
     Show all values[+]
    discounts[percentage][0..n]
     
    optional, double, min=0.01, max=100.0 
      
    discounts[amount][0..n]
     
    optional, in cents, min=0 
      
    discounts[period][0..n]
     
    optional, integer, min=1 
      
    discounts[period_unit][0..n]
     
    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.
     
     Show all values[+]
    discounts[included_in_mrr][0..n]
     
    optional, boolean 
      
    discounts[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    discounts[quantity][0..n]
     
    optional, integer, min=1 
      
     
     
    item_tiers[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    item_tiers[starting_unit][0..n]
     
    optional, integer, min=1 
      
    item_tiers[ending_unit][0..n]
     
    optional, integer 
      
    item_tiers[price][0..n]
     
    optional, in cents, default=0, min=0 
      
    item_tiers[starting_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[ending_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    item_tiers[pricing_type][0..n]
     
    optional, enumerated string 
      
    Possible values are
     
     
    per_unitIndicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).flat_feeIndicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep pricing model, pricing_type will be set to flat_fee by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.packageIndicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
     
     Show all values[+]
    item_tiers[package_size][0..n]
     
    optional, integer, min=1 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Estimate for updating a subscription
      
      
     
  Try in API Explorer
   
    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
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/estimates/update_subscription_for_items \
     -u {site_api_key}:\
     -d invoice_immediately=true \
     -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 
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    changes_scheduled_at[]
     
    
      optional, timestamp(UTC) in seconds 
     
     Caution 
    This parameter is unavailable when the Subscription Ramps feature is enabled; use Create a ramp API instead.
     
     When change_option is set to specific_date, then set the date/time at which the subscription change is to happen or has happened. Note: It is recommended not to pass this parameter along with reactivate_from. changes_scheduled_at can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

      
    
    • Backdating must be enabled for subscription change operations.
      • 
    
    • Only the following changes can be backdated:
      • 
    
        
        
      • Changes in the recurring items or their prices.
        • 
        
      • Addition of non-recurring items.
        • 
    
      
    
    • Subscription status is active, cancelled, or non_renewing.
      • 
    
    • The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. 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 plan in the subscription is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February.
      • 

    .     
     
    change_option[]
     
    
      optional, enumerated string 
     Specifies the effective date for the subscription change. 
    Possible values are
     
     
    immediatelyThe change is carried out immediately.end_of_termThe change is carried out at the end of the current billing cycle of the subscription.specific_dateExecutes the change on a specified date. The change occurs as of the date/time defined in changes_scheduled_at. 
     Caution 
    The end_of_term and specific_date options are unavailable when the Subscription Ramps feature is enabled; use Create a ramp API instead.
     
     
     Show all values[+]
     
    mandatory_items_to_remove[[0..n]][0..n]
     
    
      optional, list of string 
     Item ids of mandatorily attached addons that are to be removed from the subscription. 
     
    replace_items_list[]
     
    
      optional, boolean, default=false 
     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. 
     
    invoice_date[]
     
    
      optional, timestamp(UTC) in seconds 
     The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is set to true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date.  taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:

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

    .     
     
    billing_cycles[]
     
    
      optional, integer, min=0 
     Billing cycles set for plan-item price is used by default. 
     
    terms_to_charge[]
     
    
      optional, integer, min=1 
     The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset. 
     
    reactivate_from[]
     
    
      optional, timestamp(UTC) in seconds 
     If the subscription status is cancelled and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
     Note: It is recommended not to pass this parameter along with changed_scheduled_at. reactivate_from can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

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

    .     
     
    billing_alignment_mode[]
     
    
      optional, enumerated string 
     Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing. 
    Possible values are
     
     
    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.
     
     Show all values[+]
     
    coupon_ids[[0..n]][0..n]
     
    
      optional, list of string 
     List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes. 
     
    replace_coupon_list[]
     
    
      optional, boolean, default=false 
     If true then the existing coupon_ids list for the subscription is replaced by the one provided. If false then the provided list gets added to the existing coupon_ids. 
     
    prorate[]
     
    
      optional, boolean 
     
       
 
    • When true: Prorated credits or charges are created as applicable for this change.
      •  
 
    • When false: The subscription is changed without creating any credits or charges.
      •  
 
    • When not provided, the value configured in the site settings is considered.
      •  

     

     Caveat 
 
    For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:
     
 
    An immediate previous change was made
     
 
       
  
    • with prorate set to false and
      •  
  
    • no changes were made to the subscription’s billing term and
      •  
  
    • a change was made to either the subscription’s items or their prices.
      •  
 
     

     
     
    end_of_term[]
     
    
      optional, boolean, default=false 
     Set this to true if you want the update to be applied at the end of the current subscription billing cycle. 
     
    force_term_reset[]
     
    
      optional, boolean, default=false 
     Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as true will have the subscription reset its term to the current date (provided end_of_term is false).
    Note: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.     
     
    reactivate[]
     
    
      optional, boolean 
     Applicable only for cancelled subscriptions. When passed as true, the canceled subscription is activated; otherwise subscription changes are made without changing its status. If not passed, subscription will be activated only if subscription_items is passed. 
     
    include_delayed_charges[]
     
    
      optional, boolean, default=false 
     If true, all the unbilled charges will be included for the invoice estimate. 
     
    use_existing_balances[]
     
    
      optional, boolean, default=true 
     The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don’t want these balances to be included you can specify 'false' for the parameter use_existing_balances. 
     
    invoice_immediately[]
     
    
      optional, boolean 
     If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.

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

    .     
     
    invoice_usages[]
     
    
      optional, boolean, default=false 
     
    Setting this attribute to true will invoice the overages for the metered item during subscription changes
    .     
     
     
     
     
     
    subscription[id]
     
    required, string, max chars=50 
      
    subscription[start_date]
     
    optional, timestamp(UTC) in seconds 
      
    subscription[trial_end]
     
    optional, timestamp(UTC) in seconds 
      
    subscription[auto_collection]
     
    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.
     
     Show all values[+]
    subscription[offline_payment_method]
     
    optional, enumerated string 
      
    Possible values are
     
     
    no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer
     
     Show all values[+]
    subscription[free_period]
     
    optional, integer, min=1 
      
    subscription[free_period_unit]
     
    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)
     
     Show all values[+]
    subscription[trial_end_action]
     
    optional, enumerated string 
      
    Possible values are
     
     
    site_defaultThis is the default value. The action configured for the site at the time when the trial ends, takes effect.plan_defaultThe action configured for the site at the time when the trial ends, takes effect.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
     
     Show all values[+]
     
     
    billing_address[line1]
     
    optional, string, max chars=150 
      
    billing_address[line2]
     
    optional, string, max chars=150 
      
    billing_address[line3]
     
    optional, string, max chars=150 
      
    billing_address[city]
     
    optional, string, max chars=50 
      
    billing_address[state_code]
     
    optional, string, max chars=50 
      
    billing_address[zip]
     
    optional, string, max chars=20 
      
    billing_address[country]
     
    optional, string, max chars=50 
      
    billing_address[validation_status]
     
    optional, enumerated string, default=not_validated 
      
    Possible values are
     
     
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
     
     Show all values[+]
     
     
    shipping_address[line1]
     
    optional, string, max chars=150 
      
    shipping_address[line2]
     
    optional, string, max chars=150 
      
    shipping_address[line3]
     
    optional, string, max chars=150 
      
    shipping_address[city]
     
    optional, string, max chars=50 
      
    shipping_address[state_code]
     
    optional, string, max chars=50 
      
    shipping_address[zip]
     
    optional, string, max chars=20 
      
    shipping_address[country]
     
    optional, string, max chars=50 
      
    shipping_address[validation_status]
     
    optional, enumerated string, default=not_validated 
      
    Possible values are
     
     
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
     
     Show all values[+]
     
     
    customer[vat_number]
     
    optional, string, max chars=20 
      
    customer[vat_number_prefix]
     
    optional, string, max chars=10 
      
    customer[registered_for_gst]
     
    optional, boolean 
      
     
     
    billing_override[max_excess_payment_usage]
     
    optional, long, min=-1 
      
    billing_override[max_refundable_credits_usage]
     
    optional, long, min=-1 
      
     
     
    subscription_items[item_price_id][0..n]
     
    required, string, max chars=100 
      
    subscription_items[quantity][0..n]
     
    optional, integer, min=1 
      
    subscription_items[quantity_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    subscription_items[unit_price][0..n]
     
    optional, in cents, min=0 
      
    subscription_items[unit_price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    subscription_items[billing_cycles][0..n]
     
    optional, integer, min=0 
      
    subscription_items[trial_end][0..n]
     
    optional, timestamp(UTC) in seconds 
      
    subscription_items[service_period_days][0..n]
     
    optional, integer, min=1, max=730 
      
    subscription_items[charge_on_event][0..n]
     
    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.
     
     Show all values[+]
    subscription_items[charge_once][0..n]
     
    optional, boolean 
      
    subscription_items[charge_on_option][0..n]
     
    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.
     
     Show all values[+]
    subscription_items[proration_type][0..n]
     
    optional, enumerated string 
      
    Possible values are
     
     
    full_termCharge the full price of the addon or give the full credit. Don't apply any proration.partial_termProrate the charges or credits for the rest of the current term.noneDon't apply any charges or credits for the addon.
     
     Show all values[+]
     
     
    discounts[apply_on][0..n]
     
    optional, 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.
     
     Show all values[+]
    discounts[duration_type][0..n]
     
    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.
     
     Show all values[+]
    discounts[percentage][0..n]
     
    optional, double, min=0.01, max=100.0 
      
    discounts[amount][0..n]
     
    optional, in cents, min=0 
      
    discounts[period][0..n]
     
    optional, integer, min=1 
      
    discounts[period_unit][0..n]
     
    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.
     
     Show all values[+]
    discounts[included_in_mrr][0..n]
     
    optional, boolean 
      
    discounts[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    discounts[quantity][0..n]
     
    optional, integer, min=1 
      
    discounts[operation_type][0..n]
     
    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.
     
     Show all values[+]
    discounts[id][0..n]
     
    optional, string, max chars=50 
      
     
     
    item_tiers[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    item_tiers[starting_unit][0..n]
     
    optional, integer, min=1 
      
    item_tiers[ending_unit][0..n]
     
    optional, integer 
      
    item_tiers[price][0..n]
     
    optional, in cents, default=0, min=0 
      
    item_tiers[starting_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[ending_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    item_tiers[pricing_type][0..n]
     
    optional, enumerated string 
      
    Possible values are
     
     
    per_unitIndicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).flat_feeIndicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep pricing model, pricing_type will be set to flat_fee by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.packageIndicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
     
     Show all values[+]
    item_tiers[package_size][0..n]
     
    optional, integer, min=1 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Subscription renewal estimate
      
      
     
  Try in API Explorer
   
     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. 
      •  

      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asyKSOceZXgNK/renewal_estimate \
     -u {site_api_key}:
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
    include_delayed_charges[]
     
    
      optional, boolean, default=true 
     If true, all the unbilled charges will be included for the invoice estimate. 
    use_existing_balances[]
     
    
      optional, boolean, default=true 
     The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don’t want these balances to be included you can specify 'false' for the parameter use_existing_balances. 
    ignore_scheduled_cancellation[]
     
    
      optional, boolean, default=false 
     if true, ignores scheduled cancellation for non renewing subscription. 
    ignore_scheduled_changes[]
     
    
      optional, boolean, default=false 
     If true, ignores all recurring charges scheduled during renewal. 
       
     
        
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Advance invoice estimate
      
      
     
  Try in API Explorer
   
     This API is used to generate an invoice estimate for preview. Estimate details include the number of billing cycles to be invoiced in advance, the number of billing cycles in one interval, advance invoicing schedules, and so on. 
      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkjcSAl6gBw1/advance_invoice_estimate \
     -u {site_api_key}:\
     -d invoice_immediately=false \
     -d terms_to_charge=3
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
      
    
      URL Format
      POST
     
    
      https://{site}.chargebee.com/api/v2/subscriptions/{subscription-id}/advance_invoice_estimate
    
     
    Method
     
     
    Input Parameters
     
      
     
    terms_to_charge[]
     
    
      optional, integer, default=1, min=1 
     
    • For schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_to_charge.
    • For schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription.
    .     
     
    invoice_immediately[]
     
    
      optional, boolean 
     Whether the charge should be invoiced immediately or added to unbilled_charges. Applicable only when schedule_type is immediate. 
     
    schedule_type[]
     
    
      optional, enumerated string 
     The type of advance invoice or advance invoicing schedule. 
    Possible values are
     
     
    immediateCharge immediately for the number of billing cycles specified by terms_to_charge.specific_datesCharge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured.fixed_intervalsCharge at fixed intervals of time. Specify the number of billing cycles that constitute an interval and the number of days before each interval that the invoice should be generated. Also specify when the schedule should end.
     
     Show all values[+]
     
     
     
     
     
    fixed_interval_schedule[number_of_occurrences]
     
    optional, integer, min=1 
      
    fixed_interval_schedule[days_before_renewal]
     
    optional, integer, min=1 
      
    fixed_interval_schedule[end_schedule_on]
     
    optional, enumerated string 
      
    Possible values are
     
     
    after_number_of_intervalsAdvance invoices are generated a specified number of timesspecific_dateEnd the advance invoicing schedule on a specific date.subscription_endAdvance invoices are generated for as long as the subscription is active.
     
     Show all values[+]
    fixed_interval_schedule[end_date]
     
    optional, timestamp(UTC) in seconds 
      
     
     
    specific_dates_schedule[terms_to_charge][0..n]
     
    optional, integer 
      
    specific_dates_schedule[date][0..n]
     
    optional, timestamp(UTC) in seconds 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Regenerate Invoice Estimate
      
      
     
  Try in API Explorer
   
     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. 
      •  

     

      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnOuSHufvfo16/regenerate_invoice_estimate \
     -u {site_api_key}:\
     -d invoice_immediately=true
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnOuSHufpzqv/regenerate_invoice_estimate \
     -u {site_api_key}:\
     -d invoice_immediately=false \
     -d date_from=1518344700 \
     -d date_to=1519381500 \
     -d prorate=true
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
      
    
      URL Format
      POST
     
    
      https://{site}.chargebee.com/api/v2/subscriptions/{subscription-id}/regenerate_invoice_estimate
    
     
    Method
     
     
    Input Parameters
     
      
     
    date_from[]
     
    
      optional, timestamp(UTC) in seconds 
     The start date of the period being invoiced. The default value is current_term_start. 
     
    date_to[]
     
    
      optional, timestamp(UTC) in seconds 
     The end date of the period being invoiced. The default value is current_term_end. 
     
    prorate[]
     
    
      optional, boolean 
     Whether the charges should be prorated according to the term specified by date_from and date_to. Should not be passed without date_from and date_to. 
     
    invoice_immediately[]
     
    
      optional, boolean 
     Only applicable when Consolidated Invoicing is enabled for the customer. Set to false to leave the current term charge for the subscription as unbilled. Once you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges to invoice them. 
     
     
        
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Upcoming invoices estimate
      
      
     
  Try in API Explorer
   
     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. 
      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/customers/__test__8asyKSOcec7pP6/upcoming_invoices_estimate \
     -u {site_api_key}:
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
      
       
     
        
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Subscription change term end estimate
      
      
     
  Try in API Explorer
   
     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. 
      •  

      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asyKSOceZF8N6/change_term_end_estimate \
     -u {site_api_key}:\
     -d term_ends_at=1566697500
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    term_ends_at[]
     
    
      required, timestamp(UTC) in seconds 
     The time at which the current term should end for this subscription. 
     
    prorate[]
     
    
      optional, boolean 
     Applicable for active / non_renewing subscriptions. If specified as true prorated charges / credits will be added during this operation. 
     
    invoice_immediately[]
     
    
      optional, boolean 
     If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.

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

    .     
     
     
        
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Cancel subscription for items estimate
      
      
     
  Try in API Explorer
   
    Creates an estimate for canceling the specified subscription.
      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8ass3SIVLJaId/cancel_subscription_for_items_estimate \
     -u {site_api_key}:\
     -d credit_option_for_current_term_charges="PRORATE" \
     -d end_of_term=false
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    cancel_option[]
     
    
      optional, enumerated string 
     
    If the subscription does not have a contract term:
     
    Determines when to cancel the subscription.
     
    If the subscription has a contract term:
     
    This parameter is not applicable.
     
    Possible values are
     
     
    immediatelyThis is used to cancel the subscription with immediate effectend_of_termThis is used to cancel a subscription at the end of the current billing cyclespecific_dateThis is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in cancel_atend_of_billing_termThis is used to cancel a subscription either at the end of the advance term, if it's billed for future renewals or at the end of its current billing cycle
     
     Show all values[+]
     
    end_of_term[]
     
    
      optional, boolean, default=false 
     
    (Deprecated) Use cancel_option instead.
     
    Applicable only when the subscription does not have contract terms.
     
    Set this to true if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status changes to non_renewing. 
     
     
    cancel_at[]
     
    
      optional, timestamp(UTC) in seconds 
     
    If the subscription does not have a contract term:
     
    Specifies the date and time when the subscription should be canceled. Do not use this parameter when end_of_term is set to true.
     
    If the subscription has a contract term:
     
    Applicable only when contract_term_cancel_option is specific_date. Specifies the date and time to cancel the subscription and contract term.
     
    Backdating
     
    You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:
     
       
    • Backdating is enabled for subscription cancellation.
      •  
    • The current date does not exceed the backdating limit configured in Chargebee Billing.
      •  
    • The date is on or after the current_term_start.
      •  
    • The date is on or after the most recent change involving: 
         
      • Addition/change/removal of plan or addon item prices.
        •  
      • Addition of charge item prices.
        •  
       
      •  
    • The date is not more than one billing period into the past. For example, if the plan’s billing period is two months and today is April 14, cancel_at cannot be earlier than February 14.
      •  
     
     
    credit_option_for_current_term_charges[]
     
    
      optional, enumerated string 
     
    If the subscription does not have a contract term:
     
    Specifies how to handle credits for current term charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
     
    If the subscription has a contract term:
     
    Specifies how to handle credits for current term charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
     
    Possible values are
     
     
    noneNo credits notes are created.prorateProrated credits are issued.fullCredits are issues for the full value of the current term charges.
     
     Show all values[+]
     
    unbilled_charges_option[]
     
    
      optional, enumerated string 
     
    If the subscription does not have a contract term:
     
    Specifies how to handle unbilled charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
     
    If the subscription has a contract term:
     
    Specifies how to handle unbilled charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
     
    Possible values are
     
     
    invoiceAn invoice is generated immediately with the unbilled charges.deleteThe unbilled charges are deleted.
     
     Show all values[+]
     
    account_receivables_handling[]
     
    
      optional, enumerated string 
     
    If the subscription does not have a contract term:
     
    Specifies how to handle past due invoices when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
     
    If the subscription has a contract term:
     
    Specifies how to handle past due invoices when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
     
    Possible values are
     
     
    no_actionNo action is taken.schedule_payment_collectionApplies excess payments and refundable credits to past due invoices. If any amount remains and auto_collection is on, the remaining amount is automatically charged to the available payment method.write_offApplies excess payments and refundable credits to past due invoices. Any remaining balance is written off.  
      Note: The credit note for the write-off is not included in the API response.
     
     Show all values[+]
     
    refundable_credits_handling[]
     
    
      optional, enumerated string 
     
    If the subscription does not have a contract term:
     
    Specifies how to handle refundable credits when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
     
    If the subscription has a contract term:
     
    Specifies how to handle refundable credits when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
     
    Possible values are
     
     
    no_actionNo action is taken.schedule_refundRefunds remaining credits after applying them to any past due invoices.
     
     Show all values[+]
     
    contract_term_cancel_option[]
     
    
      optional, enumerated string 
     
    Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term. 
     
    Possible values are
     
     
    terminate_immediately
    Cancels the subscription and contract term immediately. Sets the contract term’s status to terminated and collects any termination fee, if applicable.  
    To specify the termination fee, include a single object in the subscription_items array. If not specified, the default termination fee is applied (if configured).
    end_of_contract_term
    Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term. 
    specific_date
    Cancels the subscription and contract term on the date specified by cancel_at. Sets action_at_term_end to cancel.
    Note: Contact Chargebee Support to enable this option for your Chargebee site.
    end_of_subscription_billing_term
    Cancels the subscription and contract term at the end of the current billing cycle. Sets action_at_term_end to cancel.
    Note: Contact Chargebee Support to enable this option for your Chargebee site.
     
     Show all values[+]
     
    invoice_date[]
     
    
      optional, timestamp(UTC) in seconds 
     The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:

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

    .     
     
    cancel_reason_code[]
     
    
      optional, string, max chars=100 
      Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive. 
     
     
     
     
     
    subscription_items[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    subscription_items[quantity][0..n]
     
    optional, integer, min=1 
      
    subscription_items[quantity_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    subscription_items[unit_price][0..n]
     
    optional, in cents, min=0 
      
    subscription_items[unit_price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    subscription_items[service_period_days][0..n]
     
    optional, integer, min=1, max=730 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Pause subscription estimate
      
      
     
  Try in API Explorer
   
     This API provides an estimate of the details pertaining to the pause_subscription operation. It returns attributes such as pause_date and resume_date. This is similar to the Pause a subscription API with the exception that the subscription is not paused. Only an estimate for this operation is created. 
     

    In the response, 
     

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

      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asyKSOcebl8Oi/pause_subscription_estimate \
     -u {site_api_key}:\
     -d pause_option="SPECIFIC_DATE" \
     -d "subscription[pause_date]"=1566698400 
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    pause_option[]
     
    
      optional, enumerated string 
     List of options to pause the subscription. 
    Possible values are
     
     
    immediatelyPause immediatelyend_of_termPause at the end of current termspecific_datePause on a specific datebilling_cycles
    Pause at the end of the current term, and resume automatically after the number of billing cycles you specify in skip_billing_cycles
     
     Show all values[+]
     
    unbilled_charges_handling[]
     
    
      optional, enumerated string 
     
    Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.
     
    Possible values are
     
     
    no_action
    Retain as unbilled
    If no_action is chosen, charges are added to the resumption invoice.
    invoice
    Invoice charges
    If invoice is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.
     
     Show all values[+]
     
     
     
     
     
    subscription[pause_date]
     
    optional, timestamp(UTC) in seconds 
      
    subscription[resume_date]
     
    optional, timestamp(UTC) in seconds 
      
    subscription[skip_billing_cycles]
     
    optional, integer, min=1 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Resume subscription estimate
      
      
     
  Try in API Explorer
   
     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. 
       
      •  

      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asyKSOcebwWOw/resume_subscription_estimate \
     -u {site_api_key}:\
     -d resume_option="IMMEDIATELY"
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    resume_option[]
     
    
      optional, enumerated string 
     List of options to resume the subscription. 
    Possible values are
     
     
    immediatelyResume immediatelyspecific_dateResume on a specific date
     
     Show all values[+]
     
    charges_handling[]
     
    
      optional, enumerated string 
     Applicable when charges get added during this operation and resume_option is set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges. 
    Possible values are
     
     
    invoice_immediatelyInvoice immediatelyadd_to_unbilled_chargesAdd to unbilled charges
     
     Show all values[+]
     
     
     
     
     
    subscription[resume_date]
     
    optional, timestamp(UTC) in seconds 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Gift subscription estimate for items
      
      
     
  Try in API Explorer
   
     This endpoint generates an estimate for a subscription that is intended to be a gift. The estimate provides details about the gift sender, gift recipient, address details of the recipient, and the type and details of subscription items included in the gift. 
      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    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
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    coupon_ids[[0..n]][0..n]
     
    
      optional, list of string 
     List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes. 
     
     
     
     
     
    gift[scheduled_at]
     
    optional, timestamp(UTC) in seconds 
      
    gift[auto_claim]
     
    optional, boolean, default=false 
      
    gift[no_expiry]
     
    optional, boolean 
      
    gift[claim_expiry_date]
     
    optional, timestamp(UTC) in seconds 
      
     
     
    gifter[customer_id]
     
    required, string, max chars=50 
      
    gifter[signature]
     
    required, string, max chars=50 
      
    gifter[note]
     
    optional, string, max chars=500 
      
    gifter[payment_src_id]
     
    optional, string, max chars=40 
      
     
     
    gift_receiver[customer_id]
     
    required, string, max chars=50 
      
    gift_receiver[first_name]
     
    required, string, max chars=150 
      
    gift_receiver[last_name]
     
    required, string, max chars=150 
      
    gift_receiver[email]
     
    required, string, max chars=70 
      
     
     
    payment_intent[id]
     
    optional, string, max chars=150 
      
    payment_intent[gateway_account_id]
     
    required if payment intent token provided, string, max chars=50 
      
    payment_intent[gw_token]
     
    optional, string, max chars=65k 
      
    payment_intent[payment_method_type]
     
    optional, enumerated string 
      
    Possible values are
     
     
    cardcardidealidealsofortsofortbancontactbancontact
     
     Show all values[+]
    payment_intent[reference_id]
     
    optional, string, max chars=65k 
      
    payment_intent[additional_information]
     
    optional, jsonobject 
      
     
     
    shipping_address[first_name]
     
    optional, string, max chars=150 
      
    shipping_address[last_name]
     
    optional, string, max chars=150 
      
    shipping_address[email]
     
    optional, string, max chars=70 
      
    shipping_address[company]
     
    optional, string, max chars=250 
      
    shipping_address[phone]
     
    optional, string, max chars=50 
      
    shipping_address[line1]
     
    optional, string, max chars=150 
      
    shipping_address[line2]
     
    optional, string, max chars=150 
      
    shipping_address[line3]
     
    optional, string, max chars=150 
      
    shipping_address[city]
     
    optional, string, max chars=50 
      
    shipping_address[state_code]
     
    optional, string, max chars=50 
      
    shipping_address[state]
     
    optional, string, max chars=50 
      
    shipping_address[zip]
     
    optional, string, max chars=20 
      
    shipping_address[country]
     
    optional, string, max chars=50 
      
    shipping_address[validation_status]
     
    optional, enumerated string, default=not_validated 
      
    Possible values are
     
     
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
     
     Show all values[+]
     
     
    subscription_items[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    subscription_items[quantity][0..n]
     
    optional, integer, default=1, min=1 
      
    subscription_items[quantity_in_decimal][0..n]
     
    optional, string, max chars=33 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Create invoice for items estimate
      
      
     
  Try in API Explorer
   
     This endpoint creates an invoice estimate for non-recurring items. 
      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    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
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "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
    
     
    Method
     
     
    Input Parameters
     
      
     
    currency_code[]
     
    
      required if Multicurrency is enabled, string, max chars=3 
     The currency code (ISO 4217 format) of the invoice amount. 
     
    invoice_note[]
     
    
      optional, string, max chars=2000 
     A note for this particular invoice. This, and all other notes for the invoice are displayed on the PDF invoice sent to the customer. 
     
    remove_general_note[]
     
    
      optional, boolean, default=false 
     Set as true to remove the general note from this invoice. 
     
    coupon_ids[[0..n]][0..n]
     
    
      optional, list of string 
     List of Coupons to be added. 
     
    authorization_transaction_id[]
     
    
      optional, string, max chars=40 
     Authorization transaction to be captured. 
     
    payment_source_id[]
     
    
      optional, string, max chars=40 
     Payment source to be used for this payment. 
     
    auto_collection[]
     
    
      optional, enumerated string 
     The customer level auto collection will be override if specified. 
    Possible values are
     
     
    onWhenever an invoice is created, an automatic attempt will be made to charge.offWhenever an invoice is created as payment due.
     
     Show all values[+]
     
    invoice_date[]
     
    
      optional, timestamp(UTC) in seconds 
     The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
taxes and
line_item_taxes are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December. 
     
     
     
     
     
    invoice[customer_id]
     
    optional, string, max chars=50 
      
    invoice[subscription_id]
     
    optional, string, max chars=50 
      
    invoice[po_number]
     
    optional, string, max chars=100 
      
     
     
    shipping_address[first_name]
     
    optional, string, max chars=150 
      
    shipping_address[last_name]
     
    optional, string, max chars=150 
      
    shipping_address[email]
     
    optional, string, max chars=70 
      
    shipping_address[company]
     
    optional, string, max chars=250 
      
    shipping_address[phone]
     
    optional, string, max chars=50 
      
    shipping_address[line1]
     
    optional, string, max chars=150 
      
    shipping_address[line2]
     
    optional, string, max chars=150 
      
    shipping_address[line3]
     
    optional, string, max chars=150 
      
    shipping_address[city]
     
    optional, string, max chars=50 
      
    shipping_address[state_code]
     
    optional, string, max chars=50 
      
    shipping_address[state]
     
    optional, string, max chars=50 
      
    shipping_address[zip]
     
    optional, string, max chars=20 
      
    shipping_address[country]
     
    optional, string, max chars=50 
      
    shipping_address[validation_status]
     
    optional, enumerated string, default=not_validated 
      
    Possible values are
     
     
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
     
     Show all values[+]
     
     
    billing_address[line1]
     
    optional, string, max chars=150 
      
    billing_address[line2]
     
    optional, string, max chars=150 
      
    billing_address[line3]
     
    optional, string, max chars=150 
      
    billing_address[city]
     
    optional, string, max chars=50 
      
    billing_address[state_code]
     
    optional, string, max chars=50 
      
    billing_address[zip]
     
    optional, string, max chars=20 
      
    billing_address[country]
     
    optional, string, max chars=50 
      
    billing_address[validation_status]
     
    optional, enumerated string, default=not_validated 
      
    Possible values are
     
     
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
     
     Show all values[+]
     
     
    item_prices[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    item_prices[quantity][0..n]
     
    optional, integer, min=1 
      
    item_prices[quantity_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_prices[unit_price][0..n]
     
    optional, in cents, min=0 
      
    item_prices[unit_price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    item_prices[date_from][0..n]
     
    optional, timestamp(UTC) in seconds 
      
    item_prices[date_to][0..n]
     
    optional, timestamp(UTC) in seconds 
      
     
     
    item_tiers[item_price_id][0..n]
     
    optional, string, max chars=100 
      
    item_tiers[starting_unit][0..n]
     
    optional, integer, min=1 
      
    item_tiers[ending_unit][0..n]
     
    optional, integer 
      
    item_tiers[price][0..n]
     
    optional, in cents, default=0, min=0 
      
    item_tiers[starting_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[ending_unit_in_decimal][0..n]
     
    optional, string, max chars=33 
      
    item_tiers[price_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    item_tiers[pricing_type][0..n]
     
    optional, enumerated string 
      
    Possible values are
     
     
    per_unitIndicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).flat_feeIndicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep pricing model, pricing_type will be set to flat_fee by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.packageIndicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
     
     Show all values[+]
    item_tiers[package_size][0..n]
     
    optional, integer, min=1 
      
     
     
    charges[discount_amount][0..n]
     
    optional, in cents, min=0 
      
    charges[discount_percentage][0..n]
     
    optional, double, min=0.01, max=100.0 
      
    charges[amount][0..n]
     
    optional, in cents, min=1 
      
    charges[amount_in_decimal][0..n]
     
    optional, string, max chars=39 
      
    charges[description][0..n]
     
    optional, string, max chars=250 
      
    charges[taxable][0..n]
     
    optional, boolean, default=true 
      
    charges[tax_profile_id][0..n]
     
    optional, string, max chars=50 
      
    charges[avalara_tax_code][0..n]
     
    optional, string, max chars=50 
      
    charges[hsn_code][0..n]
     
    optional, string, max chars=50 
      
    charges[taxjar_product_code][0..n]
     
    optional, string, max chars=50 
      
    charges[avalara_sale_type][0..n]
     
    optional, enumerated string 
      
    Possible values are
     
     
    wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
     
     Show all values[+]
    charges[avalara_transaction_type][0..n]
     
    optional, integer 
      
    charges[avalara_service_type][0..n]
     
    optional, integer 
      
    charges[date_from][0..n]
     
    optional, timestamp(UTC) in seconds 
      
    charges[date_to][0..n]
     
    optional, timestamp(UTC) in seconds 
      
     
     
    notes_to_remove[entity_type][0..n]
     
    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
     
     Show all values[+]
    notes_to_remove[entity_id][0..n]
     
    optional, string, max chars=100 
      
     
     
    discounts[percentage][0..n]
     
    optional, double, min=0.01, max=100.0 
      
    discounts[amount][0..n]
     
    optional, in cents, min=0 
      
    discounts[quantity][0..n]
     
    optional, integer, min=1 
      
    discounts[apply_on][0..n]
     
    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.
     
     Show all values[+]
    discounts[item_price_id][0..n]
     
    optional, string, max chars=100 
      
     
     
    tax_providers_fields[provider_name][0..n]
     
    optional, string, max chars=50 
      
    tax_providers_fields[field_id][0..n]
     
    optional, string, max chars=50 
      
    tax_providers_fields[field_value][0..n]
     
    optional, string, max chars=50 
      
       
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x
    
    
      Create a payment schedule estimate
      
     
    Idempotency Supported
     
     
  Try in API Explorer
   
    Generates an estimate without creating a payment schedule. This endpoint can be called when you want to preview details of a new payment schedule before actually creating one. 
      
    Notes
     
     
    
        Sample Request
      
     
    
  Try in API Explorer

     
     
    curl  https://{site}.chargebee.com/api/v2/estimates/payment_schedules \
     -u {site_api_key}:\
     -d scheme_id="scheme1" \
     -d invoice_id="cbdemo_inv_003" \
     -d amount=100000 \
     -d payment_schedule_start_date=1707302531
     
    
      copy
      
    Click to Copy
     
     
    200:
     
    OK
     
    STATUS
     
    
    Sample Response [ JSON ]
     
    Show more...
     
    {
    "estimate": {
        "created_at": 1707302531,
        "payment_schedule_estimates": [
            {
                "id": "__dev__Hw7wpIzUKlI7yLl",
                "entity_type": "invoice",
                "entity_id": "cbdemo_inv_003",
                "scheme_id": "scheme1",
                "currency_code": "USD",
                "object": "payment_schedule_estimate",
                "schedule_entries": [
                    {
                        "id": "__dev__Hw7wpIzUKlI7yWm",
                        "date": 1707302531,
                        "amount": 33333,
                        "status": "posted",
                        "object": "schedule_entry"
                    },
                    {..}
                ]
            },
            {..}
        ]
    }
}
     
    
      URL Format
      POST
     
    
      https://{site}.chargebee.com/api/v2/estimates/payment_schedules
    
     
    Method
     
     
    Input Parameters
     
      
     
    scheme_id[]
     
    
      required, string 
     The unique identifier for the payment_schedule_scheme. This identifier is used to retrieve the payment schedule scheme, which is then applied to calculate the amount and date for the specified number of payment schedules. 
     
    amount[]
     
    
      optional, in cents, min=0 
     Defines the payment schedule amount set for an invoice. If this is not provided, the total invoice.amount_due is used. This value is mandatory in case invoice_id is not provided. 
     
    invoice_id[]
     
    
      optional, string 
     Unique identifier of the invoice. 
     
    payment_schedule_start_date[]
     
    
      optional, timestamp(UTC) in seconds 
     The date from which the payment schedule will start. This is applicable only when invoice_id is not provided. If invoice_id is provided, we will consider invoice.due_date. 
     
     
        
     
    Returns
     
    estimate  estimate
     
    
      always returned 
     Resource object representing estimate
     
    Sample admin console URL
     
    
      https://{site}.chargebee.com/admin-console/estimates/123x