When you are retrieving resources using our APIs such as the List Subscriptions or List Customers API, you might need to filter the results based on custom fields.


Chargebee allows you to use Custom Fields as a filter with our List APIs. This option will be enabled on request (its not available by default), so please contact support@chargebee.com to enable this for your account.


The custom field filter param will appear on the API docs based on the custom field names on your site once this option is enabled for you. You will find them in the Filter Param list of the required List APIs.

In the screenshot below, you can see the custom fields from a sample Chargebee site listed as filter params.




 Note: We support only 5 string custom fields per entity via API as filters at the moment.


Related articles and documentation:

How do I create a Custom Field in my Chargebee account?
How to display custom fields to customers?