If you’re a company that sells multiple product lines then each product line or service is an item family in the Chargebee API. For example, if you are a SaaS company that offers separate products for project management, content collaboration, and customer support. Each of those can be an item family under which the various plans, addons and charges can be the items.
Item families compartmentalize items such that only items belonging to the same family can be part of any given subscription.
Note: You must have the Product Families enabled for your site to be able to set up item families.
optional, enumerated string Status of the item family.
Possible values are
activeThe item family is active and can be used to create new items.deletedThe item family has been deleted and cannot be used to create new items. The id and name can be reused to create a new item family.
optional, long The version number of this resource. For every change made to the resource, resource_version is updated with a new timestamp in milliseconds.
optional, enumerated string The subscription channel this object originated from and is maintained in.
Possible values are
webThe object was created (and is maintained) for the web channel directly in Chargebee via API or UI.app_storeThe object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.play_storeThe object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
optional, string, max chars=50 The unique ID of the
business entity of this item_family. This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
This is a list of the event types we currently support. We will continue
to add more events moving forward. All events follow a uniform pattern -
<resource>_<event_name>. The resources that will be
present in the event content are provided beneath each event type's
description.
Note: If consolidated invoicing is enabled, the
attributes invoice.subscription_id and
credit_note.subscription_id should not be used
(as it will not be present if the invoice / credit note has lines from
multiple subscriptions). Instead to know the related subscriptions,
their line_items' subscription_id attribute should be referred.
optional, enumerated string Status of the item family.
Possible values are
activeThe item family is active and can be used to create new items.deletedThe item family has been deleted and cannot be used to create new items. The id and name can be reused to create a new item family.
optional, long The version number of this resource. For every change made to the resource, resource_version is updated with a new timestamp in milliseconds.
optional, enumerated string The subscription channel this object originated from and is maintained in.
Possible values are
webThe object was created (and is maintained) for the web channel directly in Chargebee via API or UI.app_storeThe object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.play_storeThe object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
optional, string, max chars=50 The unique ID of the
business entity of this item_family. This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
optional, string, max chars=50 The unique ID of the business entity for this item_family. 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 means of a custom HTTP header.
Returns a list of item families satisfying all the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
This API is not enabled for live sites by default. Please contact
support to get this enabled.
optional, string, max chars=1000 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.
optional, string filter The identifier for the item family. It is unique and immutable.Possible values are : Supported operators : is, is_not, starts_with, in, not_in
Example →id[is] = "family-id"
+
id
The identifier for the item family. It is unique and immutable. pass parameters as id[<param name>][<operator>]
id[is][operator]
id[is][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
id[is_not][operator]
id[is_not][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
id[starts_with][operator]
id[starts_with][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
id[in][operator]
id[in][operator]
optional, string filter Possible values are : Supported operators :
Example →
id[not_in][operator]
id[not_in][operator]
optional, string filter Possible values are : Supported operators :
Example →
name[<operator>]
name[<operator>]
optional, string filter A unique display name for the item family. This is visible only in Chargebee and not to customers.Possible values are : Supported operators : is, is_not, starts_with
Example →name[is] = "family-name"
+
name
A unique display name for the item family. This is visible only in Chargebee and not to customers. pass parameters as name[<param name>][<operator>]
name[is][operator]
name[is][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
name[is_not][operator]
name[is_not][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
name[starts_with][operator]
name[starts_with][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
updated_at[<operator>]
updated_at[<operator>]
optional, timestamp(UTC) in seconds filter When the item family was last updated.Possible values are : Supported operators : after, before, on, between
Example →updated_at[after] = "1243545465"
+
updated_at
When the item family was last updated. pass parameters as updated_at[<param name>][<operator>]
updated_at[after][operator]
updated_at[after][operator]
optional, timestamp(UTC) in seconds filter Possible values are : Supported operators :
Example →
updated_at[before][operator]
updated_at[before][operator]
optional, timestamp(UTC) in seconds filter Possible values are : Supported operators :
Example →
updated_at[on][operator]
updated_at[on][operator]
optional, timestamp(UTC) in seconds filter Possible values are : Supported operators :
Example →
updated_at[between][operator]
updated_at[between][operator]
optional, string filter Possible values are : Supported operators :
Example →
business_entity_id[<operator>]
business_entity_id[<operator>]
optional, string filter The unique ID of the
business entity of this item_family. Learn more about all the scenarios before using this filter.
Possible values are : Supported operators : is, is_present
Example →business_entity_id[is] = "business_entity_id"
+
business_entity_id
The unique ID of the
business entity of this item_family. Learn more about all the scenarios before using this filter.
pass parameters as business_entity_id[<param name>][<operator>]
business_entity_id[is][operator]
business_entity_id[is][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
business_entity_id[is_present][operator]
business_entity_id[is_present][operator]
optional, enumerated string filter Possible values are : true, false Supported operators :
Example →
include_site_level_resources[<operator>]
include_site_level_resources[<operator>]
optional, enumerated string filter
Default value is true . To exclude site-level resources in specific cases, set this parameter to false.
Possible values are : true, false Supported operators : is
Example →include_site_level_resources[is] = "null"
+
include_site_level_resources
Default value is true . To exclude site-level resources in specific cases, set this parameter to false.
pass parameters as include_site_level_resources[<param name>][<operator>]
include_site_level_resources[is][operator]
include_site_level_resources[is][operator]
optional, enumerated string filter Possible values are : true, false Supported operators :
always returned optional, string, max chars=1000 This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
Deletes an item family, marking its status as deleted. This is not allowed if there are active items under the item family. Once deleted, the id and name of the item family can be reused to create a new item family.
This API is not enabled for live sites by default. Please contact
support to get this enabled.
Notes
Sample Request
Try in API Explorer
Only for Java
copy full code
Click to Copy
curl https://{site}.chargebee.com/api/v2/item_families/acme-inc/delete \
-X POST \
-u {site_api_key}:
Settings
Configure SDK
