Creates an attached addon or a charge item for a plan.
Sample Request
URL Format
Input Parameters
The id of the addon or charge that is being attached to the plan-item.
The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items.
The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.
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.
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
.
The decimal representation of the quantity of the addon. Returned for quantity-based addons when multi-decimal pricing is enabled.
Indicates when the item is charged. This parameter only applies to charge-items.
the time of creation of the subscription.
the time when the trial period of the subscription begins.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
the moment a subscription enters an active
or non-renewing
state. Also includes reactivations of canceled subscriptions.
when a contract term is terminated .
Item can be charged on demand
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.
The unique ID of the business entity for this attached_item. This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id will not be included in the API response.
Note: An alternative way of passing this parameter is by using a custom HTTP header or query string parameter.
Returns
Resource object representing attached_item