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.
Sample Item familyJSON
Item families attributes
A unique display name for the item family. This is visible only in Chargebee and not to customers.
Status of the item family.
The item family is active and can be used to create new items.
The 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.
The version number of this resource. For every change made to the resource, resource_version
is updated with a new timestamp in milliseconds.
The subscription channel this object originated from and is maintained in.
The object was created (and is maintained) for the web channel directly in Chargebee via API or UI.
The 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.
The 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.
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.