POST /exports/attached_items

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Valid values:

• "all-disabled"

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

skip all actions to be done on the events

Valid values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Valid values:

• "all-disabled"

Parameters for attached_item

Filter attached items based on their id.

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

• 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

Valid values:

• "subscription_activation"
• "plan_activation"
• "subscription_creation"
• "contract_termination"
• "subscription_trial_start"
• "on_demand"

• 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

Valid values:

• "subscription_activation"
• "plan_activation"
• "subscription_creation"
• "contract_termination"
• "subscription_trial_start"
• "on_demand"

The id of the plan-item to which the item is attached.

Filter attached items based on the type of attached item. Possible values are : recommended, mandatory, optional.

• 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.

Valid values:

• "optional"
• "recommended"
• "mandatory"

• 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.

Valid values:

• "optional"
• "recommended"
• "mandatory"

Filter attached items based on the item_id of the item being attached.

Filter attached items based on when the attached items were last updated.

optional, enumerated string filterTo filter based on the type of of the attached item. Possible values are : addon, charge. Possible values are : plan, addon, charge.Supported operators : is, is_not, in, not_inExample → item_type[is_not] = "plan"

* `plan` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. * `addon` - A recurring component that can be added to a subscription in addition to its plan. * `charge` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer directly without being applied to a subscription.

Valid values:

• "plan"
• "charge"
• "addon"

* `plan` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. * `addon` - A recurring component that can be added to a subscription in addition to its plan. * `charge` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer directly without being applied to a subscription.

Valid values:

• "plan"
• "charge"
• "addon"