Custom Fields
Extend RevKeen with your own data fields
Custom Fields allow you to capture additional information on customers, orders, and subscriptions that's specific to your business needs.
Accessing Custom Fields
Navigate to Settings → Custom Fields to manage your fields.
What are Custom Fields?
Custom fields let you store additional data on RevKeen objects:
- Customers - Industry, company size, account manager
- Orders - Special instructions, project codes, PO numbers
- Subscriptions - Contract ID, renewal notes
- Checkout - Collect info during checkout (license plate, T-shirt size)
Supported Entities
| Entity | Description |
|---|---|
| Customer | Fields appear on customer profiles |
| Order | Fields appear on one-time orders |
| Subscription | Fields appear on subscriptions |
| Checkout | Fields collected during checkout |
Field Types
| Type | Description | Use Case |
|---|---|---|
| Text | Single line text input | Names, IDs, short notes |
| Textarea | Multi-line text input | Descriptions, instructions |
| Number | Numeric input | Quantities, scores, employee count |
| Select | Dropdown with predefined options | Categories, industries, status |
| Multi-Select | Multiple selections allowed | Tags, features, interests |
| Date | Date picker | Birthdays, contract dates |
| Checkbox | Yes/No toggle | Opt-ins, confirmations |
Creating a Custom Field
- Click Add Field
- Select the entity (Customer, Order, etc.)
- Enter a field name
- Select the field type
- Configure options:
- Required - Must be filled
- Visible to customer - Shown on portal/checkout
- Editable by customer - Customer can update
- For Select/Multi-Select, add the options
- Click Create Field
Field names become machine-readable keys. Use descriptive names that work well in your code (e.g., "company_size" instead of "Size").
Checkout Custom Fields
Collect information during checkout:
- Create a custom field with entity type "Checkout"
- Mark it as required if needed
- The field appears on the checkout page
- Data is stored with the order or subscription
Common checkout fields:
- T-shirt size
- Dietary restrictions
- License plate number
- Purchase order number
- Gift message
Viewing Custom Field Data
Custom field values appear:
- On the entity detail page (Customer, Order, etc.)
- In list views (enable column)
- In exports (CSV, reports)
- Via API in the metadata object
- In webhook payloads
Filtering by Custom Fields
Use custom fields to filter lists:
- Go to the entity list (Customers, Orders, etc.)
- Click Filters
- Select your custom field
- Enter the filter value
- Apply the filter
Editing Custom Fields
You can modify certain field properties:
| Property | Editable? | Notes |
|---|---|---|
| Display name | Yes | Rename anytime |
| Required | Yes | Only affects new entries |
| Visibility | Yes | Show/hide from customers |
| Field type | No | Cannot change after creation |
| Options (Select) | Add only | Can add options, not remove |
Deleting Custom Fields
To delete a custom field:
- Click the field to edit
- Click Delete Field
- Confirm deletion
Deleting a field removes it from the interface but existing data is preserved in the metadata. You can recreate the field with the same key to restore access.