Quotes

always returned

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.

optional

When a quote is created, it generates the quoted_subscription 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.

optional
When the operation_type of a quote is onetime_invoice, the quoted_charges resource contains the details of the invoice that is eventually created once the quote is invoiced. It is always returned along with the quote.

Create a quote for new subscription line items of a customer.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/customers/__test__KyVkhnS3NssjH7/create_subscription_quote_for_items \
     -X POST  \
     -u {site_api_key}:\
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[quantity][0]"=1

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/customers/__test__KyVkhnS3NssjH7/create_subscription_quote_for_items \
     -X POST  \
     -u {site_api_key}:\
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[quantity][0]"=1

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 1000,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVkhnS3NssjH7",
        "date": 1517475933,
        "id": "1",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__KyVkhnS3NssjH7",
                "date_from": 1517475933,
                "date_to": 1519895133,
                "description": "basic USD",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "__test__KyVkhnS3NstZzH",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "create_subscription_for_customer",
        "price_type": "tax_exclusive",
        "resource_version": 1517475934000,
        "status": "open",
        "sub_total": 1000,
        "taxes": [],
        "total": 1000,
        "updated_at": 1517475934,
        "valid_till": 1517596199,
        "version": 1
    }
}

Method

name[]

optional, string, max chars=100
The quote name will be used as the pdf name of the quote.

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, list of string
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 values are

immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.

coupon_ids[]

optional, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.

subscription

Parameters for subscription

id

optional, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

po_number

optional, string, max chars=100
Purchase order number for this subscription.

trial_end

optional, timestamp(UTC) in seconds
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date. Set it to 0 to have no trial period.

start_date

optional, timestamp(UTC) in seconds
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:

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 plan in the subscription is 2 months and today is 14th April, subscription[start_date] cannot be earlier than 14th February.

contract_term_billing_cycle_on_renewal

optional, integer, min=1, max=100
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.

shipping_address

Parameters for shipping_address

first_name

optional, string, max chars=150
The first name of the contact.

last_name

optional, string, max chars=150
The last name of the contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

contract_term

Parameters for contract_term

action_at_term_end

optional, enumerated string
Action to be taken when the contract term completes.

Possible values are

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.

evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.

cancellation_cutoff_period

optional, integer, default=0
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

subscription_items

Parameters for subscription_items

item_price_id

required, string, max chars=100
The unique identifier of the item price.

quantity

optional, integer, min=1
The quantity of the item purchased

quantity_in_decimal

optional, string, max chars=33
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.

unit_price

optional, in cents, min=0
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.

unit_price_in_decimal

billing_cycles

optional, integer, min=0
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.

trial_end

optional, timestamp(UTC) in seconds
The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.

service_period_days

optional, integer, min=1, max=730
The service period of the item in days from the day of charge.

charge_on_event

optional, enumerated string
When charge_on_option option is set to on_event, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

Possible values are

subscription_creationthe time of creation of the subscription.subscription_trial_startthe time when the trial period of the subscription begins.plan_activationsame as subscription activation, but also includes the case when the plan-item of the subscription is changed.subscription_activationthe moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.contract_terminationwhen a contract term is terminated.

charge_once

optional, boolean
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.

charge_on_option

optional, enumerated string
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

Possible values are

immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.

discounts

Parameters for discounts

apply_on

required, enumerated string
The amount on the quote to which the discount is applied.

Possible values are

invoice_amountThe discount is applied to the invoice sub_total.specific_item_priceThe discount is applied to the invoice.line_item.amount that corresponds to the item price specified by item_price_id.

duration_type

required, enumerated string, default=forever
Specifies the time duration for which this discount is attached to the subscription.

Possible values are

one_timeThe discount stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.foreverThe discount is attached to the subscription and applied on the invoices till it is explicitly removed.limited_periodThe discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit.

percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it.

amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency.

period

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

period_unit

optional, enumerated string
The unit of time for period. Applicable only when duration_type is limited_period.

Possible values are

dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.

included_in_mrr

optional, boolean
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.

item_price_id

optional, string, max chars=100
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.

item_tiers

Parameters for item_tiers

item_price_id

optional, string, max chars=100
The id of the item price for which the tier price is being overridden.

starting_unit

optional, integer, min=1
The lowest value in the quantity tier.

ending_unit

optional, integer
The highest value in the quantity tier.

price

optional, in cents, default=0, min=0
The overridden price of the tier. The value depends on the type of currency.

starting_unit_in_decimal

optional, string, max chars=33
The decimal representation of the 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.

ending_unit_in_decimal

optional, string, max chars=33
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.

price_in_decimal

optional, string, max chars=39
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.

pricing_type

optional, enumerated string
Pricing type for the tier.

Possible values are

package_size

always returned

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.

optional

Changes the quote produced for creating a new subscription items

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/4/edit_create_subscription_quote_for_items \
     -X POST  \
     -u {site_api_key}:\
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[unit_price][0]"=1520 \
     -d "subscription_items[quantity][0]"=3

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/4/edit_create_subscription_quote_for_items \
     -X POST  \
     -u {site_api_key}:\
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[unit_price][0]"=1520 \
     -d "subscription_items[quantity][0]"=3

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 4560,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVlFpS4cWDaQi",
        "date": 1517485108,
        "id": "4",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 4560,
                "customer_id": "__test__KyVlFpS4cWDaQi",
                "date_from": 1517485108,
                "date_to": 1519904308,
                "description": "basic USD",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "__test__KyVlFpS4cWDxA10",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 3,
                "tax_amount": 0,
                "unit_amount": 1520
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "create_subscription_for_customer",
        "price_type": "tax_exclusive",
        "resource_version": 1517485108000,
        "status": "open",
        "sub_total": 4560,
        "taxes": [],
        "total": 4560,
        "updated_at": 1517485108,
        "valid_till": 1517596199,
        "version": 2
    }
}

Method

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, list of string
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 values are

coupon_ids[]

optional, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.

subscription

Parameters for subscription

id

optional, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

po_number

optional, string, max chars=100
Purchase order number for this subscription.

trial_end

start_date

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 plan in the subscription is 2 months and today is 14th April, subscription[start_date] cannot be earlier than 14th February.

contract_term_billing_cycle_on_renewal

shipping_address

Parameters for shipping_address

first_name

optional, string, max chars=150
The first name of the contact.

last_name

optional, string, max chars=150
The last name of the contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

contract_term

Parameters for contract_term

action_at_term_end

optional, enumerated string
Action to be taken when the contract term completes.

Possible values are

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.

evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.

cancellation_cutoff_period

subscription_items

Parameters for subscription_items

item_price_id

required, string, max chars=100
The unique identifier of the item price.

quantity

optional, integer, min=1
The quantity of the item purchased

quantity_in_decimal

optional, string, max chars=33
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.

unit_price

unit_price_in_decimal

billing_cycles

trial_end

optional, timestamp(UTC) in seconds
The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.

service_period_days

optional, integer, min=1, max=730
The service period of the item in days from the day of charge.

charge_on_event

Possible values are

charge_once

optional, boolean
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.

charge_on_option

optional, enumerated string
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

Possible values are

immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.

discounts

Parameters for discounts

apply_on

required, enumerated string
The amount on the quote to which the discount is applied.

Possible values are

duration_type

required, enumerated string, default=forever
Specifies the time duration for which this discount is attached to the subscription.

Possible values are

percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it.

amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency.

period

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

period_unit

optional, enumerated string
The unit of time for period. Applicable only when duration_type is limited_period.

Possible values are

dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.

included_in_mrr

item_price_id

optional, string, max chars=100
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.

item_tiers

Parameters for item_tiers

item_price_id

optional, string, max chars=100
The id of the item price for which the tier price is being overridden.

starting_unit

optional, integer, min=1
The lowest value in the quantity tier.

ending_unit

optional, integer
The highest value in the quantity tier.

price

optional, in cents, default=0, min=0
The overridden price of the tier. The value depends on the type of currency.

starting_unit_in_decimal

optional, string, max chars=33
The decimal representation of the 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.

ending_unit_in_decimal

optional, string, max chars=33
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.

price_in_decimal

pricing_type

optional, enumerated string
Pricing type for the tier.

Possible values are

package_size

always returned

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.

optional

Create a quote for updating subscription line items.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/update_subscription_quote_for_items \
     -u {site_api_key}:\
     -d "subscription[id]"="__test__KyVlFpS4cWD9fW" \
     -d "billing_address[first_name]"="John" \
     -d "billing_address[last_name]"="Doe" \
     -d "billing_address[line1]"="PO Box 9999" \
     -d "billing_address[city]"="Walnut" \
     -d "billing_address[state]"="California" \
     -d "billing_address[zip]"="91789" \
     -d "billing_address[country]"="US" \
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[quantity][0]"=2 \
     -d "subscription_items[unit_price][0]"=1000

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/update_subscription_quote_for_items \
     -u {site_api_key}:\
     -d "subscription[id]"="__test__KyVlFpS4cWD9fW" \
     -d "billing_address[first_name]"="John" \
     -d "billing_address[last_name]"="Doe" \
     -d "billing_address[line1]"="PO Box 9999" \
     -d "billing_address[city]"="Walnut" \
     -d "billing_address[state]"="California" \
     -d "billing_address[zip]"="91789" \
     -d "billing_address[country]"="US" \
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[quantity][0]"=2 \
     -d "subscription_items[unit_price][0]"=1000

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 1000,
        "amount_paid": 0,
        "billing_address": {
            "city": "Walnut",
            "country": "US",
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "object": "billing_address",
            "state": "California",
            "validation_status": "not_validated",
            "zip": "91789"
        },
        "charge_on_acceptance": 0,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVlFpS4cWD2iU",
        "date": 1517485106,
        "id": "3",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1000,
                "customer_id": "__test__KyVlFpS4cWD2iU",
                "date_from": 1517485106,
                "date_to": 1519904305,
                "description": "basic USD - Prorated Charges",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "__test__KyVlFpS4cWDW2g",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 1000
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "change_subscription",
        "price_type": "tax_exclusive",
        "resource_version": 1517485106000,
        "status": "open",
        "sub_total": 1000,
        "subscription_id": "__test__KyVlFpS4cWD9fW",
        "taxes": [],
        "total": 1000,
        "updated_at": 1517485106,
        "valid_till": 1517596199,
        "version": 1
    }
}

Method

name[]

optional, string, max chars=100
The quote name will be used as the pdf name of the quote.

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.

mandatory_items_to_remove[]

optional, list of string
Item ids of mandatorily attached addons that are to be removed from the subscription.

replace_items_list[]

optional, boolean, default=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.

billing_cycles[]

optional, integer, min=0
Billing cycles set for plan-item price is used by default.

terms_to_charge[]

optional, integer, min=1
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.

reactivate_from[]

optional, timestamp(UTC) in seconds
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.

billing_alignment_mode[]

optional, enumerated string
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.

Possible values are

coupon_ids[]

optional, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.

replace_coupon_list[]

optional, boolean, default=false
Should be true if the existing coupons should be replaced with the ones that are being passed.

change_option[]

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

Possible values are

immediatelyThe change is carried out immediately.specific_dateThe change is carried out as of the date specified under changes_scheduled_at.

changes_scheduled_at[]

optional, timestamp(UTC) in seconds
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.

Note: The changes_scheduled_at parameter does not apply to auto_collection, shipping_address, and po_number; these parameters take effect immediately when scheduling a subscription update.

force_term_reset[]

optional, boolean, default=false
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.

reactivate[]

optional, boolean
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.

subscription

Parameters for subscription

id

required, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

start_date

optional, timestamp(UTC) in seconds
The new start date of a future subscription. Applicable only for future subscriptions.

trial_end

optional, timestamp(UTC) in seconds
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.

auto_collection

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

Possible values are

onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.

offline_payment_method

optional, enumerated string
The preferred offline payment method for the subscription.

Possible values are

no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer

Show all values[+]

contract_term_billing_cycle_on_renewal

billing_address

Parameters for billing_address

first_name

optional, string, max chars=150
The first name of the billing contact.

last_name

optional, string, max chars=150
The last name of the billing contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

shipping_address

Parameters for shipping_address

first_name

optional, string, max chars=150
The first name of the contact.

last_name

optional, string, max chars=150
The last name of the contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

customer

Parameters for customer

vat_number

optional, string, max chars=20
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.

vat_number_prefix

registered_for_gst

optional, boolean
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.

contract_term

Parameters for contract_term

action_at_term_end

optional, enumerated string, default=renew
Action to be taken when the contract term completes.

Possible values are

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.

evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed 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.

cancellation_cutoff_period

optional, integer
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

subscription_items

Parameters for subscription_items

item_price_id

required, string, max chars=100
The unique identifier of the item price.

quantity

optional, integer, min=1
The quantity of the item purchased

quantity_in_decimal

optional, string, max chars=33
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.

unit_price

unit_price_in_decimal

optional, string, max chars=39
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.

billing_cycles

trial_end

optional, timestamp(UTC) in seconds
The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.

service_period_days

optional, integer, min=1, max=730
The service period of the item in days from the day of charge.

charge_on_event

Possible values are

charge_once

optional, boolean
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.

charge_on_option

optional, enumerated string
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

Possible values are

immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.

discounts

Parameters for discounts

apply_on

required, enumerated string
The amount on the quote to which the discount is applied.

Possible values are

duration_type

required, enumerated string, default=forever
Specifies the time duration for which this discount is attached to the subscription.

Possible values are

percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it.

amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency.

period

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

period_unit

optional, enumerated string
The unit of time for period. Applicable only when duration_type is limited_period.

Possible values are

dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.

included_in_mrr

item_price_id

optional, string, max chars=100
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.

operation_type

required, enumerated string
The operation to be carried out for the discount.

Possible values are

addThe discount is attached to the subscription.removeThe discount (given by discounts[id]) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip: If you want to replace a discount, remove it and add another in the same API call.

id

optional, string, max chars=50
The id of the discount to be removed. This parameter is only relevant when discounts[operation_type] is remove.

item_tiers

Parameters for item_tiers

item_price_id

optional, string, max chars=100
The id of the item price for which the tier price is being overridden.

starting_unit

optional, integer, min=1
The lowest value in the quantity tier.

ending_unit

optional, integer
The highest value in the quantity tier.

price

optional, in cents, default=0, min=0
The overridden price of the tier. The value depends on the type of currency.

starting_unit_in_decimal

optional, string, max chars=33
The decimal representation of the 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.

ending_unit_in_decimal

optional, string, max chars=33
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.

price_in_decimal

pricing_type

optional, enumerated string
Pricing type for the tier.

Possible values are

package_size

always returned

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.

optional

Changes the quote produced for updating the subscription items.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/6/edit_update_subscription_quote_for_items \
     -X POST  \
     -u {site_api_key}:\
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[unit_price][0]"=1520 \
     -d "subscription_items[quantity][0]"=2

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/6/edit_update_subscription_quote_for_items \
     -X POST  \
     -u {site_api_key}:\
     -d "subscription_items[item_price_id][0]"="basic-USD" \
     -d "subscription_items[unit_price][0]"=1520 \
     -d "subscription_items[quantity][0]"=2

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 1290,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 0,
        "credits_applied": 1750,
        "currency_code": "USD",
        "customer_id": "__test__KyVlFpS4cWEDZ1I",
        "date": 1517485111,
        "id": "6",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 3040,
                "customer_id": "__test__KyVlFpS4cWEDZ1I",
                "date_from": 1517485111,
                "date_to": 1519904310,
                "description": "basic USD - Prorated Charges",
                "discount_amount": 0,
                "entity_id": "basic-USD",
                "entity_type": "plan_item_price",
                "id": "__test__KyVlFpS4cWEpb1i",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "per_unit",
                "quantity": 2,
                "tax_amount": 0,
                "unit_amount": 1520
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "change_subscription",
        "price_type": "tax_exclusive",
        "resource_version": 1517485111000,
        "status": "open",
        "sub_total": 3040,
        "subscription_id": "__test__KyVlFpS4cWES31O",
        "taxes": [],
        "total": 3040,
        "updated_at": 1517485111,
        "valid_till": 1517596199,
        "version": 2
    }
}

Method

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.

mandatory_items_to_remove[]

optional, list of string
Item ids of mandatorily attached addons that are to be removed from the subscription.

replace_items_list[]

billing_cycles[]

optional, integer, min=0
Billing cycles set for plan-item price is used by default.

terms_to_charge[]

reactivate_from[]

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.

billing_alignment_mode[]

optional, enumerated string
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.

Possible values are

coupon_ids[]

optional, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.

replace_coupon_list[]

optional, boolean, default=false
Should be true if the existing coupons should be replaced with the ones that are being passed.

change_option[]

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

Possible values are

immediatelyThe change is carried out immediately.specific_dateThe change is carried out as of the date specified under changes_scheduled_at.

changes_scheduled_at[]

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.

force_term_reset[]

reactivate[]

subscription

Parameters for subscription

start_date

optional, timestamp(UTC) in seconds
The new start date of a future subscription. Applicable only for future subscriptions.

trial_end

auto_collection

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

Possible values are

offline_payment_method

optional, enumerated string
The preferred offline payment method for the subscription.

Possible values are

no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer

Show all values[+]

contract_term_billing_cycle_on_renewal

billing_address

Parameters for billing_address

first_name

optional, string, max chars=150
The first name of the billing contact.

last_name

optional, string, max chars=150
The last name of the billing contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

shipping_address

Parameters for shipping_address

first_name

optional, string, max chars=150
The first name of the contact.

last_name

optional, string, max chars=150
The last name of the contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

customer

Parameters for customer

vat_number

vat_number_prefix

registered_for_gst

contract_term

Parameters for contract_term

action_at_term_end

optional, enumerated string, default=renew
Action to be taken when the contract term completes.

Possible values are

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.

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.

cancellation_cutoff_period

subscription_items

Parameters for subscription_items

item_price_id

required, string, max chars=100
The unique identifier of the item price.

quantity

optional, integer, min=1
The quantity of the item purchased

quantity_in_decimal

optional, string, max chars=33
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.

unit_price

unit_price_in_decimal

billing_cycles

trial_end

optional, timestamp(UTC) in seconds
The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.

service_period_days

optional, integer, min=1, max=730
The service period of the item in days from the day of charge.

charge_on_event

Possible values are

charge_once

optional, boolean
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.

charge_on_option

optional, enumerated string
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

Possible values are

immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.

discounts

Parameters for discounts

apply_on

required, enumerated string
The amount on the quote to which the discount is applied.

Possible values are

duration_type

required, enumerated string, default=forever
Specifies the time duration for which this discount is attached to the subscription.

Possible values are

percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it.

amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency.

period

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

period_unit

optional, enumerated string
The unit of time for period. Applicable only when duration_type is limited_period.

Possible values are

dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.

included_in_mrr

item_price_id

optional, string, max chars=100
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.

operation_type

required, enumerated string
The operation to be carried out for the discount.

Possible values are

id

optional, string, max chars=50
The id of the discount to be removed. This parameter is only relevant when discounts[operation_type] is remove.

item_tiers

Parameters for item_tiers

item_price_id

optional, string, max chars=100
The id of the item price for which the tier price is being overridden.

starting_unit

optional, integer, min=1
The lowest value in the quantity tier.

ending_unit

optional, integer
The highest value in the quantity tier.

price

optional, in cents, default=0, min=0
The overridden price of the tier. The value depends on the type of currency.

starting_unit_in_decimal

optional, string, max chars=33
The decimal representation of the 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.

ending_unit_in_decimal

optional, string, max chars=33
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.

price_in_decimal

pricing_type

optional, enumerated string
Pricing type for the tier.

Possible values are

package_size

always returned

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.

optional

Creates a quote using charge-items and one-time charges.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/create_for_charge_items_and_charges \
     -u {site_api_key}:\
     -d customer_id="__test__KyVlFpS4cWCm4J" \
     -d "item_prices[item_price_id][0]"="ssl-charge-USD"

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/create_for_charge_items_and_charges \
     -u {site_api_key}:\
     -d customer_id="__test__KyVlFpS4cWCm4J" \
     -d "item_prices[item_price_id][0]"="ssl-charge-USD"

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 500,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 500,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVlFpS4cWCm4J",
        "date": 1517485104,
        "id": "2",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 500,
                "customer_id": "__test__KyVlFpS4cWCm4J",
                "date_from": 1517485104,
                "date_to": 1517485104,
                "description": "SSL Charge USD Monthly",
                "discount_amount": 0,
                "entity_id": "ssl-charge-USD",
                "entity_type": "charge_item_price",
                "id": "__test__KyVlFpS4cWCzmS",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 500
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "onetime_invoice",
        "price_type": "tax_exclusive",
        "resource_version": 1517485104000,
        "status": "open",
        "sub_total": 500,
        "taxes": [],
        "total": 500,
        "total_payable": 500,
        "updated_at": 1517485104,
        "valid_till": 1517596199,
        "version": 1
    }
}

Method

name[]

optional, string, max chars=100
The quote name will be used as the pdf name of the quote.

customer_id[]

required, string, max chars=50
Identifier of the customer for which the quote needs to be created.

po_number[]

optional, string, max chars=100
Purchase Order Number for this quote.

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.

currency_code[]

required if Multicurrency is enabled, string, max chars=3
The currency code (ISO 4217 format) of the quote.

coupon[]

optional, string, max chars=100
The 'One Time' coupon to be applied.

coupon_ids[]

optional, list of string
List of Coupons to be added.

shipping_address

Parameters for shipping_address

first_name

optional, string, max chars=150
The first name of the contact.

last_name

optional, string, max chars=150
The last name of the contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

item_prices

Parameters for item_prices

item_price_id

optional, string, max chars=100
A unique ID for your system to identify the item price.

quantity

optional, integer, min=1
Item price quantity

quantity_in_decimal

optional, string, max chars=33
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.

unit_price

optional, in cents, min=0
The price or per-unit-price of the item price. By default, it is the value set for the item_price. This is only applicable when the pricing_model of the item_price is flat_fee or per_unit. The value depends on the type of currency.

unit_price_in_decimal

optional, string, max chars=39
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.

service_period_days

optional, integer, min=1, max=730
Defines service period of the item in days from the day of charge.

item_tiers

Parameters for item_tiers

item_price_id

optional, string, max chars=100
The id of the item price to which this tier belongs.

starting_unit

optional, integer, min=1
The lowest value in the quantity tier.

ending_unit

optional, integer
The highest value in the quantity tier.

price

optional, in cents, default=0, min=0
The per-unit price for the tier when the pricing_model is tiered or volume. The total cost for the item price when the pricing_model is stairstep. The value is in the minor unit of the currency.

starting_unit_in_decimal

optional, string, max chars=33
The decimal representation of the 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.

ending_unit_in_decimal

optional, string, max chars=33
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.

price_in_decimal

pricing_type

optional, enumerated string
Pricing type for the tier.

Possible values are

package_size

charges

Parameters for charges

amount

optional, in cents, min=1
The amount to be charged. The unit depends on the type of currency.

amount_in_decimal

optional, string, max chars=39
The decimal representation of the amount for the one-time charge. The value is in major units of the currency. Applicable only when multi-decimal pricing is enabled.

description

optional, string, max chars=250
Description for this charge

avalara_sale_type

optional, enumerated string
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

Possible values are

wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax

avalara_transaction_type

optional, integer
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

avalara_service_type

optional, integer
Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

service_period

optional, integer
Service period for charge

discount_amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency. Either this parameter or charges[discount_percentage] should be passed.

discount_percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it. Either this parameter or charges[discount_amount] should be passed.

discounts

Parameters for discounts

percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it.

amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency.

apply_on

required, enumerated string
The amount on the quote to which the discount is applied.

Possible values are

item_price_id

optional, string, max chars=100
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.

tax_providers_fields

Parameters for tax_providers_fields

provider_name

optional, string, max chars=50
Name of the tax provider.

field_id

optional, string, max chars=50
The unique identifier belonging to a tax vendor when they are onboarded with Chargebee.

field_value

optional, string, max chars=50
The value of the corresponding tax field.

always returned

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.

Changes the quote produced for adding one-time charges and charge items.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/5/edit_for_charge_items_and_charges \
     -X POST  \
     -u {site_api_key}:\
     -d "charges[amount][0]"=1520 \
     -d "charges[description][0]"="Service Charge" \
     -d "item_prices[item_price_id][0]"="ssl-charge-USD"

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/5/edit_for_charge_items_and_charges \
     -X POST  \
     -u {site_api_key}:\
     -d "charges[amount][0]"=1520 \
     -d "charges[description][0]"="Service Charge" \
     -d "item_prices[item_price_id][0]"="ssl-charge-USD"

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 1520,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 1520,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__KyVlFpS4cWDzu12",
        "date": 1517485109,
        "id": "5",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 1520,
                "customer_id": "__test__KyVlFpS4cWDzu12",
                "date_from": 1517485109,
                "date_to": 1517485109,
                "description": "Service Charge",
                "discount_amount": 0,
                "entity_type": "adhoc",
                "id": "__test__KyVlFpS4cWE9a1G",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 1520
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "onetime_invoice",
        "price_type": "tax_exclusive",
        "resource_version": 1517485109000,
        "status": "open",
        "sub_total": 1520,
        "taxes": [],
        "total": 1520,
        "total_payable": 1520,
        "updated_at": 1517485109,
        "valid_till": 1517596199,
        "version": 2
    }
}

Method

po_number[]

optional, string, max chars=100
Purchase Order Number for this quote.

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.

currency_code[]

required if Multicurrency is enabled, string, max chars=3
The currency code (ISO 4217 format) of the quote.

coupon[]

optional, string, max chars=100
The 'One Time' coupon to be applied.

coupon_ids[]

optional, list of string
List of Coupons to be added.

shipping_address

Parameters for shipping_address

first_name

optional, string, max chars=150
The first name of the contact.

last_name

optional, string, max chars=150
The last name of the contact.

email

optional, string, max chars=70
The email address.

company

optional, string, max chars=250
The company name.

phone

optional, string, max chars=50
The phone number.

line1

optional, string, max chars=150
Address line 1

line2

optional, string, max chars=150
Address line 2

line3

optional, string, max chars=150
Address line 3

city

optional, string, max chars=50
The name of the city.

state_code

state

optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.

country

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.

validation_status

optional, enumerated string, default=not_validated
The address verification status.

Possible values are

item_prices

Parameters for item_prices

item_price_id

optional, string, max chars=100
A unique ID for your system to identify the item price.

quantity

optional, integer, min=1
Item price quantity

quantity_in_decimal

optional, string, max chars=33
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.

unit_price

unit_price_in_decimal

service_period_days

optional, integer, min=1, max=730
Defines service period of the item in days from the day of charge.

item_tiers

Parameters for item_tiers

item_price_id

optional, string, max chars=100
The id of the item price to which this tier belongs.

starting_unit

optional, integer, min=1
The lowest value in the quantity tier.

ending_unit

optional, integer
The highest value in the quantity tier.

price

starting_unit_in_decimal

optional, string, max chars=33
The decimal representation of the 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.

ending_unit_in_decimal

optional, string, max chars=33
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.

price_in_decimal

pricing_type

optional, enumerated string
Pricing type for the tier.

Possible values are

package_size

charges

Parameters for charges

amount

optional, in cents, min=1
The amount to be charged. The unit depends on the type of currency.

amount_in_decimal

optional, string, max chars=39
The decimal representation of the amount for the one-time charge. The value is in major units of the currency. Applicable only when multi-decimal pricing is enabled.

description

optional, string, max chars=250
Description for this charge

avalara_sale_type

optional, enumerated string
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

Possible values are

avalara_transaction_type

optional, integer
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.

avalara_service_type

service_period

optional, integer
Service period for charge

discount_amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency. Either this parameter or charges[discount_percentage] should be passed.

discount_percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it. Either this parameter or charges[discount_amount] should be passed.

discounts

Parameters for discounts

percentage

optional, double, min=0.01, max=100.0
The percentage of the original amount that should be deducted from it.

amount

optional, in cents, min=0
The value of the discount. The format of this value depends on the kind of currency.

apply_on

required, enumerated string
The amount on the quote to which the discount is applied.

Possible values are

item_price_id

optional, string, max chars=100
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.

tax_providers_fields

Parameters for tax_providers_fields

provider_name

optional, string, max chars=50
Name of the tax provider.

field_id

optional, string, max chars=50
The unique identifier belonging to a tax vendor when they are onboarded with Chargebee.

field_value

optional, string, max chars=50
The value of the corresponding tax field.

always returned

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.

List all quotes.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3 \
     --data-urlencode "status[in]"=["accepted"] \
     --data-urlencode "sort_by[asc]"=date

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3 \
     --data-urlencode "status[in]"=["accepted"] \
     --data-urlencode "sort_by[asc]"=date

Sample Result [ JSON ]

{
    "list": [
        {
            "quote": {
                "amount_due": 4500,
                "amount_paid": 0,
                "billing_address": {
                    "first_name": "John",
                    "last_name": "Doe",
                    "object": "billing_address",
                    "validation_status": "not_validated"
                },
                "charge_on_acceptance": 4500,
                "credits_applied": 0,
                "currency_code": "USD",
                "customer_id": "__test__8aszcSOcl5c91O",
                "date": 1517494508,
                "id": "4",
                "line_item_discounts": [],
                "line_item_taxes": [],
                "line_items": [
                    {
                        "amount": 4000,
                        "customer_id": "__test__8aszcSOcl5c91O",
                        "date_from": 1517494508,
                        "date_to": 1517494508,
                        "description": "Encryption Charge USD Monthly",
                        "discount_amount": 0,
                        "entity_id": "encryption-charge-USD",
                        "entity_type": "charge_item_price",
                        "id": "__test__8aszcSOcl5hA1Z",
                        "is_taxed": false,
                        "item_level_discount_amount": 0,
                        "object": "line_item",
                        "pricing_model": "flat_fee",
                        "quantity": 1,
                        "tax_amount": 0,
                        "unit_amount": 4000
                    },
                    {..}
                ],
                "object": "quote",
                "operation_type": "onetime_invoice",
                "price_type": "tax_exclusive",
                "resource_version": 1517494508444,
                "status": "accepted",
                "sub_total": 4500,
                "taxes": [],
                "total": 4500,
                "total_payable": 4500,
                "updated_at": 1517494508,
                "valid_till": 1526134508,
                "version": 1
            }
        },
        {..}
    ]
}

Method

limit[]

optional, integer, default=10, min=1, max=100
The number of resources to be returned.

offset[]

optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

include_deleted[]

optional, boolean, default=false
If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted' attribute will be 'true'.

sort_by

optional, string filter
Sorts based on the specified attribute.
Supported attributes : date
Supported sort-orders :

Example →
This will sort the result based on the 'date' attribute in ascending(earliest first) order.

Filter Params

For operator usages, see the Pagination and Filtering section.

id

optional, string filter
The quote number. Acts as a identifier for quote and typically generated sequentially.
Supported operators :

Example → 123

customer_id

optional, string filter
The identifier of the customer this quote belongs to.
Supported operators :

Example → 4gmiXbsjdm

subscription_id

optional, string filter
To filter based on subscription_id.
NOTE: Not to be used if consolidated invoicing feature is enabled.
Supported operators :

Example → 4gmiXbsjdm

status

optional, enumerated string filter
Current status of this quote.
Supported operators :

Example → open

date

optional, timestamp(UTC) in seconds filter
Creation date of the quote. Typically this is the date on which quote is generated.
Supported operators :

Example → 1435054328

updated_at

optional, timestamp(UTC) in seconds filter
To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
Supported operators :

Example → 1243545465

always returned

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.

optional

next_offset

optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

This API retrieves all the quote line groups and lineitems for a quote.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/7/quote_line_groups \
     -G  \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/7/quote_line_groups \
     -G  \
     -u {site_api_key}:

Sample Result [ JSON ]

{
    "list": [
        {
            "quote_line_group": {
                "amount_due": 4500,
                "amount_paid": 0,
                "charge_event": "immediate",
                "credits_applied": 0,
                "id": "qlg___test__8aszcSOcl7oQ2N",
                "line_item_discounts": [],
                "line_item_taxes": [],
                "line_items": [
                    {
                        "amount": 4000,
                        "customer_id": "__test__8aszcSOcl7j12D",
                        "date_from": 1517494516,
                        "date_to": 1517494516,
                        "description": "Encryption Charge USD Monthly",
                        "discount_amount": 0,
                        "entity_id": "encryption-charge-USD",
                        "entity_type": "charge_item_price",
                        "id": "__test__8aszcSOcl7oR2O",
                        "is_taxed": false,
                        "item_level_discount_amount": 0,
                        "object": "line_item",
                        "pricing_model": "flat_fee",
                        "quantity": 1,
                        "tax_amount": 0,
                        "unit_amount": 4000
                    },
                    {..}
                ],
                "object": "quote_line_group",
                "sub_total": 4500,
                "taxes": [],
                "total": 4500,
                "version": 1
            }
        },
        {..}
    ]
}

Method

limit[]

optional, integer, default=10, min=1, max=100
The number of resources to be returned.

offset[]

quote_line_group

always returned

The line items of a quote are grouped by charge event. Each of these groups is called a quote line group. A quote would have at least one quote line group. Let’s look at an example.

Consider the following:

A monthly plan A for $500 per month.
A non-recurring addon B for $50.

Now consider a quote that is created for 3 billing cycles of the plan with the addon applied immediately. This quote would be associated with a list of quote line groups: one for each charge event as shown below:

Quote Line group 1

Plan A: $500
Addon B: $50
Total: $550

Quote Line group 2

Plan A: $500
Total: $500

Quote Line group 3

Plan A: $500
Total: $500

next_offset

optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

This API is to convert a quote to an invoice.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/1/convert \
     -X POST  \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/1/convert \
     -X POST  \
     -u {site_api_key}:

Sample Result [ JSON ]

{
    "customer": {
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1517494504,
        "deleted": false,
        "excess_payments": 0,
        "first_name": "John",
        "id": "__test__8aszcSOcl4hbQ",
        "last_name": "Doe",
        "net_term_days": 0,
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "gateway_account_id": "gw___test__8at1FSOcl3IX1y",
            "object": "payment_method",
            "reference_id": "tok___test__8aszcSOcl4n5R",
            "status": "valid",
            "type": "card"
        },
        "pii_cleared": "active",
        "preferred_currency_code": "USD",
        "primary_payment_source_id": "pm___test__8aszcSOcl4nKS",
        "promotional_credits": 0,
        "refundable_credits": 0,
        "resource_version": 1517494504941,
        "taxability": "taxable",
        "unbilled_charges": 0,
        "updated_at": 1517494504
    },
    "invoice": {
        "adjustment_credit_notes": [],
        "amount_adjusted": 0,
        "amount_due": 0,
        "amount_paid": 4500,
        "amount_to_collect": 0,
        "applied_credits": [],
        "base_currency_code": "USD",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8aszcSOcl4hbQ",
        "date": 1517494506,
        "deleted": false,
        "due_date": 1517494506,
        "dunning_attempts": [],
        "exchange_rate": 1,
        "first_invoice": true,
        "has_advance_charges": false,
        "id": "__demo_inv__1",
        "is_gifted": false,
        "issued_credit_notes": [],
        "line_items": [
            {
                "amount": 4000,
                "customer_id": "__test__8aszcSOcl4hbQ",
                "date_from": 1517494506,
                "date_to": 1517494506,
                "description": "Encryption Charge USD Monthly",
                "discount_amount": 0,
                "entity_id": "encryption-charge-USD",
                "entity_type": "charge_item_price",
                "id": "li___test__8aszcSOcl5Bvi",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "tax_exempt_reason": "tax_not_configured",
                "unit_amount": 4000
            },
            {..}
        ],
        "linked_orders": [],
        "linked_payments": [
            {
                "applied_amount": 4500,
                "applied_at": 1517494506,
                "txn_amount": 4500,
                "txn_date": 1517494506,
                "txn_id": "txn___test__8aszcSOcl5Fuk",
                "txn_status": "success"
            },
            {..}
        ],
        "net_term_days": 0,
        "new_sales_amount": 4500,
        "object": "invoice",
        "paid_at": 1517494506,
        "price_type": "tax_exclusive",
        "recurring": false,
        "resource_version": 1517494506800,
        "round_off_amount": 0,
        "status": "paid",
        "sub_total": 4500,
        "tax": 0,
        "term_finalized": true,
        "total": 4500,
        "updated_at": 1517494506,
        "write_off_amount": 0
    },
    "quote": {
        "amount_due": 4500,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 4500,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8aszcSOcl4hbQ",
        "date": 1517494506,
        "id": "1",
        "invoice_id": "__demo_inv__1",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 4000,
                "customer_id": "__test__8aszcSOcl4hbQ",
                "date_from": 1517494505,
                "date_to": 1517494505,
                "description": "Encryption Charge USD Monthly",
                "discount_amount": 0,
                "entity_id": "encryption-charge-USD",
                "entity_type": "charge_item_price",
                "id": "__test__8aszcSOcl55eb",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 4000
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "onetime_invoice",
        "price_type": "tax_exclusive",
        "resource_version": 1517494506843,
        "status": "invoiced",
        "sub_total": 4500,
        "taxes": [],
        "total": 4500,
        "total_payable": 4500,
        "updated_at": 1517494506,
        "valid_till": 1526134505,
        "version": 1
    }
}

Method

invoice_date[]

optional, timestamp(UTC) in seconds
The document date displayed on the invoice PDF. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. When not provided, the value is the same as current date. Moreover, if the invoice is created as pending, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:

invoice_date must be in the past.
invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
The date is not earlier than quoted_subscription.start_date or quoted_subscription.changes_scheduled_at (whichever is applicable).
invoice_immediately must be true.

invoice_immediately[]

optional, boolean
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.

Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.

create_pending_invoices[]

optional, boolean
This attribute is set to true automatically for the subscription when it has one or more metered items. However, when there are no metered items, you can pass this parameter as true to force all invoices (except the first) to be created as pending. This is useful in the following scenarios:

When you manage metered billing at your end by calculating usage-based charges yourself and add them to the subscription as one-time charges.
When your workflow involves inspecting all charges before you close invoices.

Note:

You must enable Metered Billing for this parameter to be acceptable.
To create the first invoice also as pending, pass first_invoice_pending as true.

first_invoice_pending[]

optional, boolean, default=false

Non-metered items are billed at the beginning of a billing cycle while metered items are billed at the end. Consequently, the first invoice of the subscription contains only the non-metered items.

By passing this parameter as true, you create the first invoice as pending allowing you to add the previous term’s metered charges to it before closing. This is useful when the subscription is moved to Chargebee from a different billing system. As applicable to all pending invoices, this invoice is also closed automatically or via an API call.

Note:

This parameter is passed only when there are metered items in the subscription or when create_pending_invoices is true.

subscription

Parameters for subscription

id

optional, string, max chars=50
Applicable only for create subscription quote.

auto_collection

optional, enumerated string
Applicable only for create subscription quote.

Possible values are

po_number

optional, string, max chars=100
Purchase order number for this subscription.

auto_close_invoices

optional, boolean
When auto-closing of invoices is enabled for the site, you can pass this parameter as false to prevent the automatic closing of invoices for this subscription. The value passed here takes precedence over the value stored at the customer level.

always returned

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.

optional

customer

always returned

Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with subscriptions, card information, and billing addresses. The customer details include their ID, name, contact information, and any custom attributes you'd like to associate with them.

Breaking Change:

Sites created before March 1, 2014: updating the card deletes the customer's billing_address and vat_number and replaces them with values from the request.
Sites created on or after March 1, 2014: updating the card doesn't change the billing_address and vat_number.

subscription

optional

A Chargebee subscription connects a customer record to products/services. It describes what the customer has signed up for and how often they're charged for it. The essential components of a subscription are:

A plan-item price.
Any addon- and charge-item prices applied to the subscription.
Any coupons applied.
Any discounts applied.

The charges in a subscription are billed via invoices.

Note: The maximum number of subscriptions for any given customer (active or not) is 900.

Subscription billing frequencies

Chargebee offers two billing frequency options for subscriptions:

Plan-based billing (default): Subscriptions are billed based on the billing period defined for the item price of the item_type plan. Learn more.
Multi-frequency billing: Subscriptions are billed according to the billing period of each recurring item price within the subscription. Learn more.

Important

Limitations of Multi-frequency billing.

Private Beta

Multi-frequency billing is in private beta. Please reach out to the Chargebee support to enable this feature.

The selection of the billing frequency preference is configured at the site level.

Item price compatibility in a subscription

When creating or updating a subscription, one of the item prices specified under subscription_items must be a plan-item price. The remaining must be compatible addon- or charge-item prices. An item price is compatible with a plan-item price if their currencies are the same. Additionally, an addon-item price is compatible with a plan-item price only if their billing frequencies meet the following conditions:

`period_unit` for plan-item price	Compatible `period_unit` for addon-item price	Compatible period for addon-item price
`day`	`day`	The `period` of the plan-item price should be divisible by the `period` of the addon-item price. Example If the `period` of the plan-item price is `10`, then the period of the addon-item price can be `10`, `5`, `2`, or `1`.
`week`	`week` or `day`	The `period` (in days) of the plan-item price should be divisible by the `period` of the addon-item price. Example If the `period` of the plan-item price is `2`, then the period of the addon-item price can be as follows depending on the value of `period_unit`: for `period_unit` as `week`, `period` can be `2` or `1`. for `period_unit` as `day`, `period` can be `14`, `7`, `2`, or `1`.
`month`	`month`	The `period` of the plan-item price should be divisible by the `period` of the addon-item price. Example If the `period` of the plan-item price is `6`, then the `period` of the addon-item price can be `6`, `3`, `2`, or `1`.
`year`	`year` or `month`	The `period` (in months) of the plan-item price should be divisible by the `period` of the addon-item price. Example If the `period` of the plan-item price is `2`, then the `period` of the addon-item price can be as follows depending on the value of `period_unit`: for `period_unit` as `year`, `period` can be `2` or `1`. for `period_unit` as `month`, `period` can be `24`, `12`, `8`, `6`, `4`, `3`, `2`, or `1`.

Tax provider fields

Anrok: Canadian customers can have multiple tax registration numbers. We currently support only sharing one tax registration number with Anrok. So we added a new field which can have comma separated multiple tax reg numbers for Anrok. Values configured in the field is passed as it is to Anrok for accurate tax calculation

Field ID	Field Value	APIs
`additionalTaxRegistrationNumber`	Canadian tax registration numbers in comma separated fashion.	APIs involving customer attributes. Also includes APIs where we are creating new customers. Eg: estimate, subscription, hosted pages.

Vertex: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Vertex Platform for seamless integration

Note: Field Id like customerCode, customerClass, andtaxExempted belong to the customer object.
Field Id like productCode, productClass, productTaxCode, and productClass belong to the product object.

Field ID	Field Value	APIs
`productCode`	Merchant to configure it on Vertex Platform	APIs having Plan(PC1), Addons(PC1) and Item Prices(PC2) attributes.
`productClass`
`customerCode`		APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages.
`customerClass`

Taxamo: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Taxamo Platform for seamless integration

Field Id	Field Value	APIs
`productTaxCode`	Merchant to configure it on Taxamo Platform	APIs having Plan(PC1), Addons(PC1) and Item Prices(PC2) attributes.
`productClass`
`taxExempted`		APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages.

cbtaxes: With CBTaxes, you can activate India IGST for customers located in Special Economic Zones (SEZ), implement zero-rated tax for SEZ customers, enable India IGST for customers outside of India, and set up zero-rated tax for customers outside of India.

Field ID	Field Value	APIs
`indiaSez`	`SEZ_IGST_TAX`	APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages.
`indiaSez`	`SEZ_ZERO_RATED_TAX`
`indiaExport`	`EXPORT_IGST_TAX`
`indiaExport`	`EXPORT_ZERO_RATED_TAX`

All: For tax inclusive tax calculation, For tax exclusive tax calculation. This is currently used for price type overriding at customer level

Field ID	Field Value	APIs
`priceType`	`TAX_INCLUSIVE`	APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages.
	`TAX_EXCLUSIVE`
	`SITE_DEFAULT` or blank	Removes price type override, and allows site level configuration to be used for tax calculation.

invoice

optional

An invoice is a commercial document representing a sale of products/services offered by you to a customer. It enumerates all the charges, adjustments, payments, discounts and taxes associated with the sale.

An invoice is said to be a recurring one when it is has at least one charge for a plan or an addon item price. It is a non-recurring one when it has charges for only charge-item prices or one-time charges.

The item prices for any given billing term of a subscription are billed via an invoice at the beginning of the term (unless the charges are left unbilled). However, item prices that belong to metered items are billed at the end of the term via a pending invoice that can close automatically or via an API call. Moreover, when there are no metered items in the subscription, the invoices can still be generated as pending while creating or updating a subscription.

Auto-collection

If auto-collection is enabled, then immediately on invoice generation (or, in case of subscriptions that have create_pending_invoices as true, on invoice closure), the payment method on file is charged:

If the payment succeeds, the invoice is marked as paid.
On payment failure, the invoice is marked as payment_due and dunning settings are taken into account for payment retries.
If no retry attempts are configured, or when retries are exhausted, the invoice is marked as not_paid.
the amount due is zero or negative, the invoice is immediately marked as paid and the balance, if any, is added to excess payments for the customer.

credit_note

optional

A Credit Note is a document that specifies the money owed by a business to its customer. The seller usually issues a Credit Note for the same or lower amount than the invoice, and then repays the money to the customer or set it off against other 'due' invoices.

Credit Note Types

Credit notes in Chargebee are categorized into three types:

1. adjustment: Adjustment credit notes are used to adjust the amount of an existing invoice in the payment_due or not_paid status. Use this type of credit note to reduce the invoice amount, typically as a discount to the customer.
Adjustment credit notes are automatically created in the following cases:

When an invoice is written off.
When a subscription is modified with proration enabled, and the invoice for the current term is in the payment_due or not_paid status.

2. refundable: Refundable credit notes allow you to return a certain amount to the customer. These credits can be:

Retained for automatic application on future invoices.
Applied to existing unpaid invoices.
Refunded to the customer.

Refundable credit notes are automatically created in the following cases:

When an invoice is refunded.
When a subscription is changed or canceled with proration enabled, the invoice for the current term is in the paid status. Refundable credits are applied to future invoices or can be refunded to the original payment method.

3. store: Store credit notes are created for paid or partially_paid invoice status during subscription changes, such as upgrades, downgrades, or cancellations.

Key characteristics of store credits:

No tax component is included at the time of creation.
A credit note document is generated, similar to refundable credits.
Store credits are applied before tax calculations on future invoices.

Note: If you have enabled consolidated invoicing, to know the subscriptions attached with a credit note you have to refer line_item's subscription_id. The credit note's subscription_id should not be used (which will be null if the credit note has lines from multiple subscriptions).

unbilled_charges

optional
Resource object representing unbilled_charge

Updates the status of the quote. Status can be updated to Accepted, Declined, and Closed.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/9/update_status \
     -u {site_api_key}:\
     -d status="ACCEPTED"

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/9/update_status \
     -u {site_api_key}:\
     -d status="ACCEPTED"

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 4500,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 4500,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8aszcSOcl82K2h",
        "date": 1517494517,
        "id": "9",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 4000,
                "customer_id": "__test__8aszcSOcl82K2h",
                "date_from": 1517494517,
                "date_to": 1517494517,
                "description": "Encryption Charge USD Monthly",
                "discount_amount": 0,
                "entity_id": "encryption-charge-USD",
                "entity_type": "charge_item_price",
                "id": "__test__8aszcSOcl88r2s",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 4000
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "onetime_invoice",
        "price_type": "tax_exclusive",
        "resource_version": 1517494518019,
        "status": "accepted",
        "sub_total": 4500,
        "taxes": [],
        "total": 4500,
        "total_payable": 4500,
        "updated_at": 1517494518,
        "valid_till": 1526134517,
        "version": 1
    }
}

Method

status[]

required, enumerated string
Status to update for the quote.

Possible values are

acceptedAccepted.declinedDeclined.closedClosed

comment[]

optional, string, max chars=300
An internal comment to be added for this operation, to the quote. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing Hosted Page or any document such as the Quote PDF.

always returned

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.

optional

Can be used to extend the expiry date of a quote.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/3/extend_expiry_date \
     -u {site_api_key}:\
     -d valid_till=1534774507

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/3/extend_expiry_date \
     -u {site_api_key}:\
     -d valid_till=1534774507

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 4500,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 4500,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8aszcSOcl5Th17",
        "date": 1517494507,
        "id": "3",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 4000,
                "customer_id": "__test__8aszcSOcl5Th17",
                "date_from": 1517494507,
                "date_to": 1517494507,
                "description": "Encryption Charge USD Monthly",
                "discount_amount": 0,
                "entity_id": "encryption-charge-USD",
                "entity_type": "charge_item_price",
                "id": "__test__8aszcSOcl5ZS1I",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 4000
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "onetime_invoice",
        "price_type": "tax_exclusive",
        "resource_version": 1517494507969,
        "status": "open",
        "sub_total": 4500,
        "taxes": [],
        "total": 4500,
        "total_payable": 4500,
        "updated_at": 1517494507,
        "valid_till": 1534774507,
        "version": 1
    }
}

Method

valid_till[]

required, timestamp(UTC) in seconds
Quote will be valid till this date. After this date quote will be marked as closed.

always returned

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.

optional

Delete a quote using this API.

Sample Codes

curl  https://{site}.chargebee.com/api/v2/quotes/2/delete \
     -X POST  \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/quotes/2/delete \
     -X POST  \
     -u {site_api_key}:

Sample Result [ JSON ]

{
    "quote": {
        "amount_due": 4500,
        "amount_paid": 0,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "charge_on_acceptance": 4500,
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "__test__8aszcSOcl5L2q",
        "date": 1517494507,
        "id": "2",
        "line_item_discounts": [],
        "line_item_taxes": [],
        "line_items": [
            {
                "amount": 4000,
                "customer_id": "__test__8aszcSOcl5L2q",
                "date_from": 1517494507,
                "date_to": 1517494507,
                "description": "Encryption Charge USD Monthly",
                "discount_amount": 0,
                "entity_id": "encryption-charge-USD",
                "entity_type": "charge_item_price",
                "id": "__test__8aszcSOcl5QU11",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "tax_amount": 0,
                "unit_amount": 4000
            },
            {..}
        ],
        "object": "quote",
        "operation_type": "onetime_invoice",
        "price_type": "tax_exclusive",
        "resource_version": 1517494507372,
        "status": "open",
        "sub_total": 4500,
        "taxes": [],
        "total": 4500,
        "total_payable": 4500,
        "updated_at": 1517494507,
        "valid_till": 1526134507,
        "version": 1
    }
}

Method

comment[]

optional, string, max chars=300
Reason for deleting quote. This comment will be added to the subscription entity if the quote belongs to a subscription or added to the customer entity if the quote is associated only with a customer.

always returned

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.

optional