Attached items

Addon-item and charge-item prices are purchased with plan-item prices in subscriptions. You can automate this process by configuring certain addons and charges as “attached” to certain plans. This is done at the “item” level. In other words, addon- and charge-items can be attached to plan-items.

Once the attachment is defined, while creating or updating a subscription, the addon- or charge-item prices are selected automatically based on the plan-item price selected . Let’s look at the details:

Addons

Addons can be attached to plans as recommended, mandatory or optional.

• When an addon is attached as recommended for a plan, the addon is suggested to be applied to subscriptions for the plan in Checkout and Self-Serve Portal. Alternatively, if you build your own payment pages or have a sales team, you can suggest recommended addons to your customers or salespeople on your website or CRM respectively
• When an addon is attached as mandatory for a plan, the addon gets applied to subscriptions for the plan compulsorily, unless removed explicitly. If you do not pass an item price for a mandatory addon when including the plan in a subscription, an addon-item price is automatically applied as explained below.
• Attaching an addon as optional neither marks it as recommended or mandatory but allows you a way to set a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.

How auto-selection of the addon-item price works

Once an addon has been attached as mandatory, the addon-item price to be applied to the plan-item price is selected based on the following rule: The addon-item price with the same currency as that of the plan-item price and the longest compatible period is selected.

Here's an example:

Consider a plan Standard Cloud Storage has an addon Extra Storage attached to it. Note that each of the two are items. Now consider that they have item prices with the following periods and currencies:

Item price for “Standard Cloud Storage” plan-item:

• Standard Cloud Storage, 3 years, AUD.

Item prices for “Extra Storage” addon-item:

• Extra Storage, 1 year, EUR.
• Extra Storage, 1 year, USD.
• Extra Storage, 1 year, AUD.
• Extra Storage, 18 months, AUD.
• Extra Storage, 2 years, AUD.
• Extra Storage, 30 months, AUD.

For the plan-item price (Standard Cloud Storage, 3 years, AUD), the addon-item prices with matching currencies are the last 4 from the above list:

• Extra Storage, 1 year, AUD.
• Extra Storage, 18 months, AUD.
• Extra Storage, 2 years, AUD.
• Extra Storage, 30 months, AUD.

From among them, the last two have periods that are incompatible with the plan-item price period of 3 years. From the remaining 2 addon-item prices, the one with the longest period is of 18 months. So, “Extra Storage, 18 months, AUD” is selected for mandatory application to the plan item price.

Charges

Charges can also be attached to plans. When doing so, you specify the event at which the charge is to be applied to the subscription. For some events that can occur multiple times in a subscription lifetime, you can also set whether to apply the charge each time the event occurs or just once.

There may be multiple item prices for a given attached charge. The item price that matches the currency of the plan-item price is automatically selected for application.

Here’s an example:

Consider a plan Standard Cloud Storage has a charge named Implementation Fee attached to it. Now consider their item prices below, with the following periods and currencies:

Item price for “Standard Cloud Storage” plan-item:

• Standard Cloud Storage, 3 years, AUD.

Item prices for “Implementation Fee” charge-item:

• Implementation Fee, USD.
• Implementation Fee, AUD.
• Implementation Fee, EUR.

From among the charge-item prices above, the one compatible with the plan-item price is “Implementation Fee, AUD” since it has the same currency as the plan-item price.

Sample attached item [ JSON ]

API Index URL GET

Creates an attached addon or a charge item for a plan.

# attach a mandatory addon item
curl  https://{site}.chargebee.com/api/v2/items/basic/attached_items \
     -X POST  \
     -u {site_api_key}:\
     -d item_id="day-pass" \
     -d type="mandatory" \
     -d quantity=1

# attach a mandatory addon item
curl  https://{site}.chargebee.com/api/v2/items/basic/attached_items \
     -X POST  \
     -u {site_api_key}:\
     -d item_id="day-pass" \
     -d type="mandatory" \
     -d quantity=1

# attach a charge item
curl  https://{site}.chargebee.com/api/v2/items/basic/attached_items \
     -X POST  \
     -u {site_api_key}:\
     -d item_id="ssl" \
     -d charge_on_event="subscription_creation" \
     -d charge_once="true"

Sample Response [ JSON ]

{"attached_item": {
    "created_at": 1594107081,
    "id": "c9109b84-732a-4093-b53d-0b9f31ccc11c",
    "item_id": "day-pass",
    "object": "attached_item",
    "parent_item_id": "basic",
    "quantity": 1,
    "resource_version": 1594107081871,
    "status": "active",
    "type": "mandatory",
    "updated_at": 1594107081
}}

{"attached_item": {
    "charge_on_event": "subscription_creation",
    "charge_once": true,
    "created_at": 1594107083,
    "id": "9e2b1598-ade1-45ec-87a3-f5fb847b2b9e",
    "item_id": "ssl",
    "object": "attached_item",
    "parent_item_id": "basic",
    "resource_version": 1594107083189,
    "status": "active",
    "updated_at": 1594107083
}}

URL Format POST

Updates an attached addon or a charge item for a plan.

curl  https://{site}.chargebee.com/api/v2/attached_items/85943f11-6014-4ab5-990d-60c86a9c2893 \
     -X POST  \
     -u {site_api_key}:\
     -d parent_item_id="cb-demo" \
     -d type="recommended"

curl  https://{site}.chargebee.com/api/v2/attached_items/85943f11-6014-4ab5-990d-60c86a9c2893 \
     -X POST  \
     -u {site_api_key}:\
     -d parent_item_id="cb-demo" \
     -d type="recommended"

curl  https://{site}.chargebee.com/api/v2/attached_items/a0d63a3a-4bea-4621-b4c9-1bb7f833a603 \
     -u {site_api_key}:\
     -d parent_item_id="cb-demo"

curl  https://{site}.chargebee.com/api/v2/attached_items/a0d63a3a-4bea-4621-b4c9-1bb7f833a603 \
     -u {site_api_key}:\
     -d parent_item_id="cb-demo"

curl  https://{site}.chargebee.com/api/v2/attached_items/bf0d81c1-eb45-4636-ad8e-5ab31099e325/delete \
     -X POST  \
     -u {site_api_key}:\
     -d parent_item_id="no-trial"

curl  https://{site}.chargebee.com/api/v2/attached_items/bf0d81c1-eb45-4636-ad8e-5ab31099e325/delete \
     -X POST  \
     -u {site_api_key}:\
     -d parent_item_id="no-trial"

curl  https://{site}.chargebee.com/api/v2/items/basic/attached_items \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=10

curl  https://{site}.chargebee.com/api/v2/items/basic/attached_items \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=10