ChargebeeAPI

Update an attached item

Idempotency Supported
Try in API Explorer

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

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/attached_items/{attached-item-id}

Input Parameters

parent_item_id
required, string, max chars=100

The id of the parent item in the attachment relationship.

type
optional, enumerated string

The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items.

Possible Enum Values
recommended

The addon is recommended to go with the plan-item when using Checkout or Portal .

mandatory

The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.

optional

The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.

billing_cycles
optional, integer, min=1

The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires addon billing cycles to be enabled for the site.

The value set explicitly for billing_cycles while applying the addon to a subscription takes precedence over this parameter. This parameter, in turn, has a higher precedence than the value set for the addon-item price .

quantity
optional, integer, min=1

The default quantity of the addon to be attached when the quantity is not specified while creating /updating the subscription.

quantity_in_decimal
optional, string, max chars=33

The decimal representation of the quantity of the addon. Returned for quantity-based addons when multi-decimal pricing is enabled.

charge_on_event
optional, enumerated string

Indicates when the item is charged. This parameter only applies to charge-items.

Possible Enum Values
subscription_creation

the time of creation of the subscription.

subscription_trial_start

the time when the trial period of the subscription begins.

plan_activation

same as subscription activation, but also includes the case when the plan-item of the subscription is changed.

subscription_activation

the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.

contract_termination

when a contract term is terminated .

on_demand

Item can be charged on demand

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.

Returns

attached_itemAttached item object

Resource object representing attached_item