Start a new topic

Access Custom Field Options via API

I'm wondering if it's possible to retrieve a list of the options associated with a custom user field?


I can't find any way to do this in the API documentation.


Thanks for your help


2 people like this idea

Hi Alex


Are you looking for an option to filter the customers/subscriptions by custom fields via API?


You could use the filter parameters under Subscriptions/Customers in the Chargebee web interface to filter out customers based on a particular custom field value. However, it is not possible at the moment to filter customers/subscriptions based on custom field values when using API, sorry about that. 


We have this feature in the product pipeline as a few customers have already asked for it in the past, though we do not have a firm ETA on the feature. I've tagged your ticket internally to keep a track of the feature request and I'll inform you as soon as this is implemented. 



1 person likes this
I'm also looking this function for the API. Do you have any plans for this or are there any other workaround available to search customers using values from custom fields? Thank you in advance!

Hi Mark, 


For you to be able to fetch a list of subscriptions or customers via API using custom fields as filters, we'll have to enable it from the backend for your site for which you would have to send an email to support@chargebee.com


However, we'd like to let you know that we have a restriction in place where you could only use 5 custom fields for the filtering purpose. We are sorry but we have this in place as it was recently released and we're trying to make further improvements on this.

Any updates to this?


 it is not possible at the moment to filter customers/subscriptions based on custom field values when using API, sorry about that. 

Hi Yuan,


We now have a functionality to filter customers/subscriptions, plans and addons using custom fields. You can filter your customer records using custom fields as a filter parameter in the “List customers API call”. For example, if your custom field name is “book” the filter parameter should be cf_book. 


To filter customers based on Custom Field, the below is the format to use in List customers API call.


Example →if the custom field name is book cf_book[is] = “sample”

The field is optional and is a string filter.

Supported operators : is, is_not, is_not_present, is_present


Custom fields has to be enabled from the backend, you can write to us at support@chargebee.com to enable it.

Login or Signup to post a comment