Product Updates
Getting Started
- Overview
- Chargebee Billing Data Centers
- Object Relationship Model
- Chargebee Tech Glossary
- Articles and FAQ
Implementing Chargebee
AI in Chargebee
Developer Resources
Product Catalog
Subscriptions
Customers
Entitlements
Usage Based Billing
Chargebee CPQ
Invoices, Credit Notes, and Quotes
Taxes
Hosted Capabilities
- Overview
- Payment Components
- Managing Payments with Chargebee.js
- Mobile-Optimized Hosted Pages
- Articles and FAQ
Site Configuration
- Mandatory Fields
- File Attachments & Comments
- Advanced Filter Options
- Multi-decimal Support
- Configuring Reason Codes
- API Keys
- Time Zone
- Time Machine
- Transfer Configurations
- Articles and FAQ
Multi Business Entity
Mobile Subscriptions
Reports and Analytics
Integrations
Data Privacy & Security
- Two Factor Authentication
- SAML Single Sign-On
- System for Cross-Domain Identity Management (SCIM)
- EU-GDPR
- Consent Management
- Personal Data Management
- Compliance Certificates
- HIPAA Guidelines
- PCI Recommendations and Integration Types
- Articles and FAQ
Data Operations
Is it possible to filter set custom fields as filters via the APIs?
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 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.
Was this article helpful?