Quoted subscriptions

The details of the subscription that would be created once the quote is invoiced.

Sample quoted subscription [ JSON ]

{
    "plan_id": "basic",
    "plan_quantity": 1,
    "billing_period": 1,
    "billing_period_unit": "month",
    "object": "quoted_subscription",
    "addons": [
        {
            "id": "ssl",
            "quantity": 1,
            "unit_price": 495,
            "object": "addon"
        },
        {..}
    ],
    "event_based_addons": [
        {
            "id": "day-pass",
            "quantity": 2,
            "unit_price": 200,
            "on_event": "subscription_creation",
            "charge_once": true,
            "object": "event_based_addon"
        },
        {..}
    ],
    "coupons": [
        {
            "coupon_id": "plan_addons_coupon",
            "object": "coupon"
        },
        {..}
    ]
}

id

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

plan_id

Identifier of the plan for this subscription.
string, max chars=100

plan_quantity

Represents the plan quantity for this subscription.
integer, default=1, min=1

plan_unit_price

Amount that will override the Plan's default price.
optional, in cents, min=0

setup_fee

Amount that will override the default setup fee.
optional, in cents, min=0

billing_period

Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
optional, integer, min=1

billing_period_unit

Defines billing frequency in association with the billing period.
optional, enumerated string

Possible values are

dayCharge based on day(s).weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).

start_date

Applicable only for 'future' subscriptions. The scheduled start time of the subscription.
optional, timestamp(UTC) in seconds

trial_end

End of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'in_trial' state when it starts.
optional, timestamp(UTC) in seconds

remaining_billing_cycles

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

.
optional, integer, min=0

po_number

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

auto_collection

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

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.

addons
Show attributes[+]

List of addons for this subscription with quantity(if applicable).
optional, list of addon

Addon attributes

id

Identifier of the addon. Multiple addons can be passed.
string, max chars=100

quantity

Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1

unit_price

Amount that will override the Addon's default price. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0

amount

optional, in cents, min=0

trial_end

The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support.).
optional, timestamp(UTC) in seconds

remaining_billing_cycles

The number of billing cycles this addon will be attached to subscription.
optional, integer, min=0

quantity_in_decimal

The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, string, max chars=33

unit_price_in_decimal

The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
optional, string, max chars=33

amount_in_decimal

The decimal representation of the total amount for the addon, in major units of the currency. Always returned when multi-decimal pricing is enabled.
optional, string, max chars=33

event_based_addons
Show attributes[+]

List of non-recurring addons that will be charged on the occurrence of specified event.
optional, list of event_based_addon

Event based addon attributes

id

A unique 'id' used to identify the addon.
string, max chars=100

quantity

Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
integer, min=0

unit_price

Amount that will override the Addon's default price.
in cents, min=0

on_event

Event on which this addon will be charged.
enumerated string

Possible values are

subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.

charge_once

If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
boolean, default=true

quantity_in_decimal

The decimal representation of the quantity of the addon. Returned for quantity-based addons when multi-decimal pricing is enabled.
optional, string, max chars=33

unit_price_in_decimal

coupons
Show attributes[+]

List of coupons for this subscription.
optional, list of coupon

Coupon attributes

coupon_id

Used to uniquely identify the coupon.
string, max chars=50

apply_till

The date till when the coupon can be applied. Applicable for limited_period coupons only.
optional, timestamp(UTC) in seconds

applied_count

Number of times this coupon has been applied for this subscription.
integer, default=0

coupon_code

The coupon code used to redeem the coupon. Will be present only when associated code for a coupon is used.
optional, string, max chars=50

subscription_items
Show attributes[+]

Details of individual item prices that are part of this subscription.
optional, list of subscription_item

Subscription item attributes

item_price_id

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

item_type

The type of item. There must be one and only one item of type plan in this list.
enumerated string

Possible values are

planPlan.addonAddon.chargeCharge.

quantity

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

unit_price

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

amount

The total amount for the item as determined from unit_price, free_quantity, quantity and item_tiers as applicable. The value depends on the type of currency.
optional, in cents, min=0

free_quantity

The free_quantity of the plan-item as specified for the item price.
optional, integer, min=0

trial_end

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

billing_cycles

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

service_period_days

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

charge_on_event

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.
optional, enumerated string

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

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

charge_on_option

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

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.

item_tiers
Show attributes[+]

optional, list of item_tier

Item tier attributes

item_price_id

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

starting_unit

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

ending_unit

The highest value in the quantity tier.
optional, integer

price

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 depends on the type of currency.
in cents, default=0, min=0

Sample quoted subscription [ JSON ]

Quoted subscription attributes