ChargebeeAPI

Edit a quote for subscription creation

Idempotency Supported
Try in API Explorer

Changes the quote produced for creating a new subscription items

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/quotes/{quote-id}/edit_create_subscription_quote_for_items

Input Parameters

notes
optional, string, max chars=2000

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

expires_at
optional, timestamp(UTC) in seconds

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

billing_cycles
optional, integer, min=0

The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan-item price is used.

mandatory_items_to_remove
optional, string, max chars=100

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

terms_to_charge
optional, integer, min=1

The number of subscription billing cycles (including the first one) to invoice in advance .

billing_alignment_mode
optional, enumerated string

Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.

Possible Enum Values
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.

coupon_ids
optional, string, max chars=100

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.

billing_start_option
optional, enumerated string, default=on_specific_date

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.

Possible Enum Values
immediately

The subscription starts immediately upon conversion of the quote to a subscription.

on_specific_date

Upon quote conversion, the subscription is scheduled to start on the specified date.

net_term_days
optional, integer

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.

subscription[0..n]
Parameters for subscription
pass parameters as subscription[<param name>]
shipping_address[0..n]
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
contract_term[0..n]
Parameters for contract_term
pass parameters as contract_term[<param name>]
billing_address[0..n]
Parameters for billing_address
pass parameters as billing_address[<param name>]
subscription_items[0..n]
Parameters for subscription_items. Multiple subscription_items can be passed by specifying unique indices.
pass parameters as subscription_items[<param name>][<idx:0..n>]
discounts[0..n]
Parameters for discounts. Multiple discounts can be passed by specifying unique indices.
pass parameters as discounts[<param name>][<idx:0..n>]
item_tiers[0..n]
Parameters for item_tiers. Multiple item_tiers can be passed by specifying unique indices.
pass parameters as item_tiers[<param name>][<idx:0..n>]
coupons[0..n]
Parameters for coupons. Multiple coupons can be passed by specifying unique indices.
pass parameters as coupons[<param name>][<idx:0..n>]

Returns

quoteQuote object
Resource object representing quote
quoted_subscriptionQuoted subscription object
Resource object representing quoted_subscription
quoted_rampQuoted ramp object
Resource object representing quoted_ramp