Create A Quote For A New Subscription Items

Create a quote for subscription creation

POST/customers/{customer-id}/create_subscription_quote_for_items

Use it in a workflow

Add a step and choose the Chargebee connector.
Pick the Create A Quote For A New Subscription Items action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{createAQuoteForANewSubscriptionItems.response.data}}.

Request

Path parameters

customer-idstringrequired

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

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

chargebee-request-origin-user-encodedstring (email)

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.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-event-actionsstring

skip all actions to be done on the events

One ofall-disabled

chargebee-event-emailstring

skip only emails

One ofall-disabled

chargebee-event-webhookstring

skip only webhooks

One ofall-disabled

chargebee-business-entity-idstring

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.

Request body

Enter the body as JSON in the step's Body field.

namestring

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

notesstring

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

expires_atinteger (unix-time)

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

billing_cyclesinteger (int32)

The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles) is used.

mandatory_items_to_removearray<string>

Item ids of [mandatorily attached addons](/docs/api/attached_items) that are to be removed from the subscription.

terms_to_chargeinteger (int32)

The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html) .

billing_alignment_modestring

Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date) for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site. \* 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.

One ofimmediatedelayed

coupon_idsarray<string>

The list of <a href="/docs/api/coupons/coupon-object#id">IDs</a> of the coupons to be applied. <a href="/docs/api/coupon_codes">Coupon codes</a> are also supported. <div class="alert alert-info">NoteNot applicable when Chargebee CPQ is enabled. Use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupons[]</code> array instead.</div>

billing_start_optionstring

When the quote is converted, this attribute determines the date/time as of when the subscription start is to be carried out. **Note** The parameter applies only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support). \* on_specific_date - Upon quote conversion, the subscription is scheduled to start on the specified date. \* immediately - The subscription starts immediately upon conversion of the quote to a subscription.

One ofimmediatelyon_specific_dateDefault "on_specific_date"

net_term_daysinteger (int32)

The number of days from <a href="/docs/api/invoices/invoice-object#date" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.date</code></a> until payment for the invoice is due. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

subscriptionobject

Parameters for subscription

idstring

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

po_numberstring

Purchase order number for this subscription.

trial_endinteger (unix-time)

End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>. Set it to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code> to have no trial period.

start_dateinteger (unix-time)

The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li> <li class="text-base leading-relaxed">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.</li> <li class="text-base leading-relaxed">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, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[start_date]</code> cannot be earlier than 14th February.</li> </ul>

offline_payment_methodstring

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

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

contract_term_billing_cycle_on_renewalinteger (int32)

Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a> .

free_periodinteger (int32)

The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">free_period_unit</code>. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">3</code> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">free_period_unit</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">month</code> adds 3 free months to the first term of the subscription. <div class="alert alert-info">Prerequisite Can be used only when Chargebee CPQ is enabled. To request access, <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">contact Chargebee Support</a>.</div>

free_period_unitstring

The time unit for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">free_period</code>. <div class="alert alert-info">Prerequisite Can be used only when Chargebee CPQ is enabled. To request access, <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">contact Chargebee Support</a>. Constraint Must be equal to or lower than the <a href="/docs/api/item_prices#period_unit" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code></a> of the plan <a href="/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_items_item_price_id" class="text-blue-600 hover:text-blue-800 underline">item price</a> of the subscription.</div> * year - Charge based on year(s) * day - Charge based on day(s) * month - Charge based on month(s) * week - Charge based on week(s)

One ofdayweekmonthyear

shipping_addressobject

Parameters for shipping_address

first_namestring

The first name of the contact.

last_namestring

The last name of the contact.

emailstring (email)

The email address.

companystring

The company name.

phonestring

The phone number.

line1string

Address line 1

line2string

Address line 2

line3string

Address line 3

citystring

The name of the city.

state_codestring

The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a> without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code> ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code> ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code> ).

statestring

The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code> is provided.

zipstring

Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address) .

countrystring

The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a> . Note: If you enter an invalid country code, the system will return an error. <div class="alert alert-info">BrexitIf you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for United Kingdom - Northern Ireland) is available as an option.</div>

validation_statusstring

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.

One ofnot_validatedvalidpartially_validinvalidDefault "not_validated"

contract_termobject

Parameters for contract_term

action_at_term_endstring

Action to be taken when the contract term completes. * evergreen - Contract term completes and the subscription renews. * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li> <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li> </ul> * cancel - Contract term completes and subscription is canceled.

One ofrenewevergreencancel

cancellation_cutoff_periodinteger (int32)

The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a> , 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.

Default 0

billing_addressobject

Parameters for billing_address.

first_namestring

The first name of the billing contact. <div class="alert alert-info">NoteThe parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and all its sub-parameters apply only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

last_namestring

The last name of the billing contact.

emailstring (email)

The email address.

companystring

The company name.

phonestring

The phone number.

line1string

Address line 1

line2string

Address line 2

line3string

Address line 3

citystring

The name of the city.

state_codestring

statestring

zipstring

Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address) .

countrystring

validation_statusstring

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.

One ofnot_validatedvalidpartially_validinvalidDefault "not_validated"

subscription_itemsobject

Parameters for subscription_items

item_price_idarray<string>required

The unique identifier of the item price.

quantityarray<integer (int32)>

The quantity of the item purchased

quantity_in_decimalarray<string>

The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started) is enabled.

unit_pricearray<integer (int64)>

The price/per unit price of the item. When not provided, <a href="/docs/api/item_prices/item-price-object">the value set</a> for the item price is used. This is only applicable when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> of the item price is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>. Also, it is only allowed when <a href="https://www.chargebee.com/docs/price-override.html" target="_blank">price overriding</a> is enabled for the site. The value depends on the type of currency. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> is in the past and a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> 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.

unit_price_in_decimalarray<string>

When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html) 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](/docs/api/item_prices/item_price-object#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](/docs/api/getting-started) is enabled.

billing_cyclesarray<integer (int32)>

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](/docs/api/item_prices/item-price-object) for the plan-item price is used. For addon-item prices: If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) 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](/docs/api/attached_items/attached-item-object) is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object) is used.

trial_endarray<integer (unix-time)>

The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html) --addon-items as well.

service_period_daysarray<integer (int32)>

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

charge_on_eventarray<string>

charge_oncearray<boolean>

Indicates if the charge-item is to be charged only once or each time the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">charge_on_event</code> occurs. This parameter only applies to charge-items.

charge_on_optionarray<string>

start_datearray<integer (unix-time)>

Specifies the start date for the item price in the subscription. The period of the item price, determined by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_date</code>, specifies the <a href="/docs/api/quoted_ramps">ramp</a> it belongs to. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

end_datearray<integer (unix-time)>

Specifies the end date for the item price in the subscription. The period of the item price, determined by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_date</code>, specifies the <a href="/docs/api/quoted_ramps">ramp</a> it belongs to. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

ramp_tier_idarray<string>

The index or identifier of the <a href="/docs/api/quoted_ramps">ramp</a> to which the item price belongs. Use this index to map <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_tier</code> values to the correct ramp, as the target <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_price</code> of an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_tier</code> may be part of multiple ramps. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

discountsobject

Parameters for discounts

apply_onarray<string>

duration_typearray<string>required

percentagearray<number (double)>

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

amountarray<integer (int64)>

The value of the discount. [The format of this value](/docs/api/currencies) depends on the kind of currency.

periodarray<integer (int32)>

The duration of time for which the discount is attached to the subscription, in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_units</code>. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">limited_period</code>.

period_unitarray<string>

included_in_mrrarray<boolean>

The discount is included in MRR calculations for your site. This attribute is only applicable when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">one_time</code> and when the <a href="https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation" target="_blank">feature is enabled</a> in Chargebee. Also, If the <a href="https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation" target="_blank">site-level setting</a> is to exclude one-time discounts from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>.

item_price_idarray<string>

The <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_price_id">id of the item price</a> in the subscription to which the discount is to be applied. Relevant only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apply_on</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_item_price</code>.

quantityarray<integer (int32)>

Specifies the number of free units provided for the item, without affecting the total quantity sold

start_datearray<integer (unix-time)>

Specifies the start date for the discount. The period of the discount, as specified by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_date</code> determines the <a href="/docs/api/quoted_ramps">ramp(s)</a> it will be part of. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

end_datearray<integer (unix-time)>

Specifies the end date for the discount. The period of the discount, as specified by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_date</code> determines the <a href="/docs/api/quoted_ramps">ramp(s)</a> it will be part of. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

item_tiersobject

Parameters for item_tiers

item_price_idarray<string>

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

starting_unitarray<integer (int32)>

The lowest value in the quantity tier.

ending_unitarray<integer (int32)>

The highest value in the quantity tier.

pricearray<integer (int64)>

The overridden price of the tier. The value depends on the [type of currency](/docs/api/quotes) .

starting_unit_in_decimalarray<string>

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 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code> of the next lower tier. Returned only when the pricing_model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code> , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code> and <a href="/docs/api/getting-started">multi-decimal pricing</a> is enabled.

ending_unit_in_decimalarray<string>

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 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code> of the next higher tier. Returned only when the pricing_model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code> , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code> and <a href="/docs/api/getting-started">multi-decimal pricing</a> is enabled.

price_in_decimalarray<string>

The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>. When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code> , 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 <a href="/docs/api/getting-started">multi-decimal pricing</a> is enabled.

pricing_typearray<string>

package_sizearray<integer (int32)>

Package size for the tier when pricing type is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">package</code>. 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.

ramp_tier_idarray<string>

The index or identifier of the <a href="/docs/api/quoted_ramps">ramp</a> to which this tier information belongs. This must be a value from the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_items[ramp_tier_id][i]</code>. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

couponsobject

idarray<string>

The [ID](/docs/api/coupons/coupon-object#id) of the coupon to be applied. [Coupon codes](/docs/api/coupon_codes) are not supported. **Note** The parameter applies only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support).

start_datearray<integer (unix-time)>

Specifies the start date for the coupon. The period of the coupon, as specified by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_date</code> determines the <a href="/docs/api/quoted_ramps">ramp(s)</a> it will be part of. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

end_datearray<integer (unix-time)>

Specifies the end date for the coupon. The period of the coupon, as specified by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_date</code> determines the <a href="/docs/api/quoted_ramps">ramp(s)</a> it will be part of. <div class="alert alert-info">NoteThe parameter applies only when Chargebee CPQ is enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div>

json

{
  "name": null,
  "notes": null,
  "expires_at": null,
  "billing_cycles": null,
  "mandatory_items_to_remove": null,
  "terms_to_charge": null,
  "billing_alignment_mode": null,
  "coupon_ids": null,
  "billing_start_option": null,
  "net_term_days": null,
  "subscription": null,
  "shipping_address": null
}

Response

Returns 200 with an object. Read it in later steps with {{createAQuoteForANewSubscriptionItems.response.data.<field>}}.

quoteobject

A quote is an estimate of the invoice with the charges likely to occur when customers buy an item. A quote can be converted to a regular invoice once the customer accepts it. The line items of a quote are grouped by charge events and are available as a separate [resource](/docs/api/quote_line_groups). This resource can be retrieved using the [List quote line groups](/docs/api/quotes/list-quote-line-groups) endpoint. Note that the first quote line group is available within the quote resource itself and parsing the quote line groups object is not required.

idstringrequired

The quote number. Acts as a identifier for quote and typically generated sequentially.

namestring

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

po_numberstring

Purchase Order Number

customer_idstringrequired

The identifier of the customer this quote belongs to.

subscription_idstring

The identifier of the subscription this quote belongs to.

invoice_idstring

The identifier of the invoice generated while converting this quote.

statusstringrequired

Current status of this quote. \* open - The quote is either newly created, or has been approved but not yet sent to the customer. \* invoiced - The accepted quote has been converted into a subscription or one-time charge and invoiced through Chargebee. \* voided - The quote has been invalidated and can no longer be acted upon. **Note** Applicable only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support). \* accepted - The customer has accepted the quote. \* closed - The quote has been marked as closed. **Note** Not applicable when Chargebee CPQ is enabled. \* declined - The customer declined/rejected the quote. \* proposed - The quote has been shared with the customer via email or e-signature and is awaiting their response. **Note** Applicable only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support). \* expired - The quote has passed its expiration date and is no longer valid. **Note** Applicable only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support). \* approval_rejected - The quote was rejected with comments, allowing for revisions. **Note** Applicable only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support). \* pending_approval - The quote has been submitted for internal approval and is awaiting review. **Note** Applicable only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support).

One ofopenaccepteddeclinedinvoicedclosedpending_approvalapproval_rejectedproposedvoidedexpired

operation_typestringrequired

Operation Type \* onetime_invoice - onetime_invoice \* create_subscription_for_customer - create_subscription_for_customer \* change_subscription - change_subscription \* renew_subscription -

One ofcreate_subscription_for_customerchange_subscriptiononetime_invoicerenew_subscription

vat_numberstring

VAT/ Tax registration number of the customer. [Learn more](https://www.chargebee.com/docs/tax.html#capture-tax-registration-number)

price_typestringrequired

The price type of the quote. \* tax_inclusive - All amounts in the document are inclusive of tax. \* tax_exclusive - All amounts in the document are exclusive of tax.

One oftax_exclusivetax_inclusiveDefault "tax_exclusive"

valid_tillinteger (unix-time)required

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

dateinteger (unix-time)required

Creation date of the quote. Typically this is the date on which quote is generated.

total_payableinteger (int64)

Total contract value. Applicable when multi billing cycle quote is enabled.

charge_on_acceptanceinteger (int64)

Charge on acceptance. Applicable when multi billing cycle quote is enabled.

Default 0

sub_totalinteger (int64)required

Subtotal (in cents) of the first quote line group.

totalinteger (int64)

Total (in cents) of the first quote line group.

Default 0

credits_appliedinteger (int64)

Credits applied (in cents) for the first quote line group.

Default 0

amount_paidinteger (int64)

Existing outstanding payments (in cents) if any, applied to the first quote line group.

Default 0

amount_dueinteger (int64)

Amount due (in cents) for the first quote line group.

Default 0

versioninteger (int32)

Version of the quote.

Default 1

resource_versioninteger (int64)

Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.

updated_atinteger (unix-time)

Timestamp indicating when this quote was last updated.

vat_number_prefixstring

An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>. Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (which is United Kingdom - Northern Ireland ). When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a> in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a> the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>. That's the code for United Kingdom - Northern Ireland. The first two characters of the VAT number in such a case is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>. Set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code> for such cases.

tax_categorystring

Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.

currency_codestringrequired

The currency code (ISO 4217 format) of the quote.

notesarray<any>

List of notes associated with this quotes.

contract_term_startinteger (unix-time)

Specifies the contract term's start date.

contract_term_endinteger (unix-time)

Specifies the contract term's end date. It indicates when the action set in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> gets triggered.

contract_term_termination_feeinteger (int64)

Specifies the charge to be applied for terminating the contract term.

business_entity_idstring

The unique ID of the [business entity](/docs/api/advanced-features) of this quote.

deletedbooleanrequired

Indicates that this resource has been deleted when the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> .

total_contract_valueinteger (int64)

The total contract value of the quote. **Note:** This parameter applies only when Chargebee CPQ is enabled. To request access, please contact [support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)

total_discountinteger (int64)

The total discount value of the quote for the contract period. **Note:** This parameter applies only when Chargebee CPQ is enabled. To request access, please contact [support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)

line_itemsarray<object>26 fields

The list of line items for this quote.

line_item_tiersarray<object>11 fields

The list of tiers applicable for the various line items in this quote.

line_item_discountsarray<object>5 fields

The list of deductions applied for each line item of this quote.

line_item_taxesarray<object>15 fields

The list of taxes applied on the line items of this quote.

discountsarray<object>7 fields

The list of all deductions applied to the quote.

taxesarray<object>3 fields

The list of taxes applicable for this quote.

shipping_addressobject14 fields

Shipping address for the quote.

quoted_subscriptionobject

<div class="api-description">When a <code><a href="/docs/api/quotes">quote</a></code> is created, it generates the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quoted_subscription</code> resource. This captures most of the details of the subscription that would eventually be created once the quote is invoiced. This resource is returned along with the quote for most of the associated operations.</div>

idstringrequired

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

billing_periodinteger (int32)

billing_period_unitstring

null

One ofdayweekmonthyear

start_dateinteger (unix-time)

trial_endinteger (unix-time)

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.

remaining_billing_cyclesinteger (int32)

* 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](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.

po_numberstring

Purchase order number for this subscription.

auto_collectionstring

null

One ofonoff

plan_quantity_in_decimalstring

The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/currencies) is enabled.

plan_unit_price_in_decimalstring

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](/docs/api/currencies) is enabled.

changes_scheduled_atinteger (unix-time)

Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">operation_type</code> of the quote is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_subscription</code>. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_option</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code> , 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: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"> Backdating must be enabled for subscription change operations. </li> <li class="text-base leading-relaxed"> Only the following changes can be backdated: </li> <li class="text-base leading-relaxed"> Changes in the recurring items or their prices. </li> <li class="text-base leading-relaxed"> Addition of non-recurring items. </li> <li class="text-base leading-relaxed"> Subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>. </li> <li class="text-base leading-relaxed"> 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. </li> <li class="text-base leading-relaxed"> The date is on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>. </li> <li class="text-base leading-relaxed"> The date is on or after the last date/time any of the following changes were made: </li> <li class="text-base leading-relaxed"> Changes in the recurring items or their prices. </li> <li class="text-base leading-relaxed"> Addition of non-recurring items. </li> <li class="text-base leading-relaxed"> 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, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February. </li> </ul>

change_optionstring

One ofend_of_termspecific_dateimmediately

free_periodinteger (int32)

The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">free_period_unit</code>. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">3</code> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">free_period_unit</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">month</code> means 3 free months are added to the first term. <div class="alert alert-info">Constraints<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">operation_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_subscription_for_customer</code>.</li> <li class="text-base leading-relaxed">Applicable only when Chargebee CPQ is enabled. To request access, <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">contact Chargebee Support</a></li> </ul></div>

free_period_unitstring

The time unit for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">free_period</code>. <div class="alert alert-info">Constraints<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">operation_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_subscription_for_customer</code>.</li> <li class="text-base leading-relaxed">Applicable only when Chargebee CPQ is enabled. To request access, <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">contact Chargebee Support</a></li> </ul></div> * week - Charge based on week(s) * month - Charge based on month(s) * day - Charge based on day(s) * year - Charge based on year(s)

One ofdayweekmonthyear

contract_term_billing_cycle_on_renewalinteger (int32)

couponsarray<object>1 fields

List of coupons for this subscription

discountsarray<object>18 fields

List of discounts for this quoted subscription.

subscription_itemsarray<object>23 fields

Details of individual [item prices](/docs/api/item_prices) that are part of this subscription

item_tiersarray<object>10 fields

List of item tier.

quoted_contract_termobject6 fields

The details of the contract term to be created when this quote is invoiced.

quoted_rampobject

<div class="api-description">When a <code><a href="/docs/api/quotes">quote</a></code> is created, it generates the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quoted_ramps</code> resource. This captures most of the details of the <a href="/docs/api/ramps">ramps</a> that would eventually be created once the quote is invoiced. This resource is returned along with the quote for most of the associated operations.<div class="alert alert-info">Note Applicable only when Chargebee CPQ and <a href="/docs/api/ramps">Subscription Ramps</a> are enabled. To request access, contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>.</div></div>

idstringrequired

line_itemsarray<object>28 fields

Provides details of the individual line items in the subscription. If the subscription includes ramps, this array contains line items from all ramps.

discountsarray<object>17 fields

List of discounts for this quoted subscription.

item_tiersarray<object>10 fields

List of item tier.

coupon_applicability_mappingsarray<object>2 fields

json

{
  "quote": null,
  "quoted_subscription": null,
  "quoted_ramp": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Was this page helpful?