POST /estimates/update_subscription_for_items

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-disabled"

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

skip all actions to be done on the events

Possible values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Possible values:

• "all-disabled"

Parameters for discounts

The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type is one_time and when the feature is enabled in Chargebee. Also, If the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned false.

An immutable unique id for the discount. It is always auto-generated.

The percentage of the original amount that should be deducted from it.

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

The value of the discount. The format of this value depends on the kind of currency.

The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.

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

Default value: false

Parameters for subscription

A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

The preferred offline payment method for the subscription. * uk_automated_bank_transfer - UK Automated Bank Transfer * jp_automated_bank_transfer - JP Automated Bank Transfer * bank_transfer - Bank Transfer * us_automated_bank_transfer - US Automated Bank Transfer * boleto - Boleto * no_preference - No Preference * sepa_credit - SEPA Credit * mx_automated_bank_transfer - MX Automated Bank Transfer * ach_credit - ACH Credit * custom - Custom * eu_automated_bank_transfer - EU Automated Bank Transfer * cash - Cash * check - Check

Possible values:

• "mx_automated_bank_transfer"
• "cash"
• "boleto"
• "no_preference"
• "bank_transfer"
• "jp_automated_bank_transfer"
• "custom"
• "check"
• "eu_automated_bank_transfer"
• "sepa_credit"
• "ach_credit"
• "us_automated_bank_transfer"
• "uk_automated_bank_transfer"

The new start date of a future subscription. Applicable only for future subscriptions.

The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property. * off - Automatic collection of charges will not be made for this subscription. Use this for offline payments. * on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.

Possible values:

• "on"
• "off"

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. * activate_subscription - The subscription activates and charges are raised for non-metered items. * cancel_subscription - The subscription cancels. * plan_default - The action configured for the site at the time when the trial ends, takes effect. * site_default - This is the default value. The action configured for the site at the time when the trial ends, takes effect.

Possible values:

• "site_default"
• "cancel_subscription"
• "activate_subscription"
• "plan_default"

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

The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen. * year - Charge based on year(s) * day - Charge based on day(s) * month - Charge based on month(s) * week - Charge based on week(s)

Possible values:

• "month"
• "day"
• "week"
• "year"

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.

Default value: false

Parameters for subscription_items

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

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

When price overriding is enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled. If changes_scheduled_at is in the past and a unit_price_in_decimal is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.

The unique identifier of the item price.

The quantity of the item purchased

The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.

The service period of the item in days from the day of charge.

The date/time when the trial period of the item ends. Applies to plan-items and----when enabled----addon-items as well.

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

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

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

• 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.

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

Parameters for billing_override

Maximum amount of excess payments that can be applied to any single invoice associated with this subscription. Set to -1 to remove this limit.

Maximum amount of refundable credits that can be applied to any single invoice associated with this subscription. Set to -1 to remove this limit.

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

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.

Default value: false

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

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.

Parameters for billing_address

Address line 2

Address line 1

Address line 3

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

Zip or postal code. The number of characters is validated according to the rules specified here.

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

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

Brexit

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

The name of the city.

The address verification status. * valid - Address was validated successfully. * partially_valid - The address is valid for taxability but has not been validated for shipping. * invalid - Address is invalid. * not_validated - Address is not yet validated.

Possible values:

• "partially_valid"
• "valid"
• "not_validated"
• "invalid"

Default value: "not_validated"

Parameters for shipping_address

Address line 2

Address line 1

Address line 3

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

Zip or postal code. The number of characters is validated according to the rules specified here.

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

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

Brexit

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

The name of the city.

The address verification status. * partially_valid - The address is valid for taxability but has not been validated for shipping. * invalid - Address is invalid. * not_validated - Address is not yet validated. * valid - Address was validated successfully.

Possible values:

• "partially_valid"
• "valid"
• "not_validated"
• "invalid"

Default value: "not_validated"

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.

Item ids of mandatorily attached addons that are to be removed from the subscription.

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.

Default value: false

Billing cycles set for plan-item price is used by default.

Setting this attribute to true will invoice the overages for the metered item during subscription changes .

Default value: false

Parameters for customer

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

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

VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.

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

If true, all the unbilled charges will be included for the invoice estimate.

Default value: false

Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing. * immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.. * delayed - Subscription period will be aligned with the configured billing date at the next renewal.

Possible values:

• "immediate"
• "delayed"

Parameters for item_tiers

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

The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.

Package size for the tier when pricing type is package. Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.

The overridden price of the tier. The value depends on the type of currency.

The highest value in the quantity tier.

The id of the item price for which the tier price is being overridden.

The lowest value in the quantity tier.

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

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

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.

Default value: true

Specifies the effective date for the subscription change. * end_of_term - The change is carried out at the end of the current billing cycle of the subscription. * specific_date - Executes 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. * immediately - The change is carried out immediately.

Possible values:

• "end_of_term"
• "immediately"
• "specific_date"