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

EntityDescription
CustomerFields appear on customer profiles
OrderFields appear on one-time orders
SubscriptionFields appear on subscriptions
CheckoutFields collected during checkout

Field Types

TypeDescriptionUse Case
TextSingle line text inputNames, IDs, short notes
TextareaMulti-line text inputDescriptions, instructions
NumberNumeric inputQuantities, scores, employee count
SelectDropdown with predefined optionsCategories, industries, status
Multi-SelectMultiple selections allowedTags, features, interests
DateDate pickerBirthdays, contract dates
CheckboxYes/No toggleOpt-ins, confirmations

Creating a Custom Field

  1. Click Add Field
  2. Select the entity (Customer, Order, etc.)
  3. Enter a field name
  4. Select the field type
  5. Configure options:
    • Required - Must be filled
    • Visible to customer - Shown on portal/checkout
    • Editable by customer - Customer can update
  6. For Select/Multi-Select, add the options
  7. 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:

  1. Create a custom field with entity type "Checkout"
  2. Mark it as required if needed
  3. The field appears on the checkout page
  4. 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:

  1. Go to the entity list (Customers, Orders, etc.)
  2. Click Filters
  3. Select your custom field
  4. Enter the filter value
  5. Apply the filter

Editing Custom Fields

You can modify certain field properties:

PropertyEditable?Notes
Display nameYesRename anytime
RequiredYesOnly affects new entries
VisibilityYesShow/hide from customers
Field typeNoCannot change after creation
Options (Select)Add onlyCan add options, not remove

Deleting Custom Fields

To delete a custom field:

  1. Click the field to edit
  2. Click Delete Field
  3. 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.

Related