POST /quotes/{quote-id}/edit_update_subscription_quote_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 shipping_address

The first name of the contact.

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

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"

Address line 2

Address line 1

The email address.

The last name of the contact.

The company name.

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

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.

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.

The id of the discount to be removed. This parameter is only relevant when discounts[operation_type] is remove.

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

Specifies the start date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.

Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

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

Specifies the end date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.

Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

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.

Parameters for subscription

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.

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"

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.

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

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.

Applicable for 'Active' & 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
Note: Specifying this value as 'false' has no impact on the default behaviour.

Default value: 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.

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 index or identifier of the ramp to which the item price belongs. Use this index to map item_tier values to the correct ramp, as the target item_price of an item_tier may be part of multiple ramps.
Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

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.

Specifies the start date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

Specifies the end date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

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.

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

The list of IDs of the coupons to be applied. Coupon codes are also supported.
Note

Not applicable when Chargebee CPQ is enabled. Use coupons[] array instead.

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.

The number of days within which the customer has to make payment for the invoice.
Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

Notes specific to this quote that you want customers to see on the quote PDF.

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 index or identifier of the ramp to which this tier information belongs. This must be a value from the subscription_items[ramp_tier_id][i]. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs.
Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

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.

When change_option is set to specific_date, then set the date/time at which the subscription change is to happen or has happened. 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 the day of the month by which the accounting for the previous month must be closed.
• The date is on or after current_term_start.
• The date is on or after the last date/time any of the following changes were made:
  • Changes in the recurring items or their prices.
  • Addition of non-recurring items.
• The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription's plan is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February. .

Should be true if the existing coupons should be replaced with the ones that are being passed.

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

The ID of the coupon to be applied. Coupon codes are not supported.
Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

Specifies the start date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.

Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

Specifies the end date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.

Note

The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.

Parameters for contract_term

Action to be taken when the contract term completes. * evergreen - Contract term completes and the subscription renews. * 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. * renew_once - Used when you want to renew the contract term just once. Does the following:
• Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
• The action_at_term_end for the new contract term is set to cancel. * cancel - Contract term completes and subscription is canceled.

Possible values:

• "renew_once"
• "evergreen"
• "cancel"
• "renew"

Default value: "renew"

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

Quotes will be valid till this date. After this quote will be marked as closed.

When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out. * end_of_term - The change is carried out at the end of the current billing cycle of the subscription. * specific_date - The change is carried out as of the date specified under changes_scheduled_at. * immediately - The change is carried out immediately.

Possible values:

• "immediately"
• "specific_date"

Parameters for billing_address

The first name of the billing contact.
Note

The parameter billing_address and all its sub-parameters apply only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

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"

Address line 2

Address line 1

The email address.

The last name of the billing contact.

The company name.

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

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.