GET /items/{item-id}/attached_items

Returns a list of attached items satisfying all the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`item-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	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.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	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.

Query parameters

Name	Type	Required	Description
`id`	Object	No	optional, string filterFilter attached items based on their id.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "bec0c324-adb6-44d3-ad4f-694f449be97c"
`charge_on_event`	Object	No	optional, enumerated string filterIndicates when the item is charged. This attribute only applies to charge-items. Possible values are : subscription_creation, subscription_trial_start, plan_activation, subscription_activation, contract_termination, on_demand.Supported operators : is, is_not, in, not_inExample → charge_on_event[is] = "subscription_creation"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`type`	Object	No	optional, enumerated string filterFilter attached items based on the `type` of attached item. Possible values are : `recommended`, `mandatory`, `optional`. Possible values are : recommended, mandatory, optional.Supported operators : is, is_not, in, not_inExample → type[is] = "mandatory"
`item_type`	Object	No	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"
`item_id`	Object	No	optional, string filterFilter attached items based on the `item_id` of the item being attached.Supported operators : is, is_not, starts_with, in, not_inExample → item_id[is] = "basic"
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.
`updated_at`	Object	No	optional, timestamp(UTC) in seconds filterFilter attached items based on when the attached items were last updated.Supported operators : after, before, on, betweenExample → updated_at[after] = "1243545465"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.