Create a quote for subscription update

The quote name will be used as the pdf name of the quote.

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

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

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.

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

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.

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

Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.

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

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

When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.

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

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.

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.

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

Note: This parameter applies only when Chargebee CPQ is enabled. To request access, please contact support

Parameters for subscription

Parameters for billing_address

Parameters for shipping_address

Parameters for customer

Parameters for contract_term

Parameters for subscription_items

Parameters for discounts

Parameters for item_tiers