Quoted subscriptions

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

Identifier of the plan for this subscription

Represents the plan quantity for this subscription.

Amount that will override the Plan's default price. The unit depends on the type of currency .

Amount that will override the default setup fee. The unit depends on the type of currency .

Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.

Defines billing frequency in association with the billing period.

Applicable only when operation_type of the quote is create_subscription_for_customer. For subscriptions in the future status , this is the date/time when the subscription is set to start. The quote can be converted on a date/time after this date. This is called backdating the subscription creation. Backdating is performed when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:

• Backdating is enabled for subscription creation operations.
• The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
• The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription's plan is 2 months and today is 14th April, the start_date cannot be earlier than 14th February.

End of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'in_trial' state when it starts.

• When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
• When the subscription is on a contract term: this value is the number of billing cycles remaining in the contract term after the current billing cycle.

Purchase order number for this subscription.

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

The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when multi-decimal pricing is enabled.

The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.

Applicable only when operation_type of the quote is change_subscription. When change_option is set to specific_date , then this is the date/time at which the subscription change is scheduled to occur. The quote can be converted on a date/time after this date. This is called backdating the subscription change and performed when the subscription change has already been provisioned but the conversion action 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 only when operation_type of the quote is change_subscription. When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.

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 .