Skip to main content
Custom attributes allow you to store additional information for various objects. Depending on the settings, these attributes can be displayed and edited both in the API and in the user interface. These can be defined for Customers, Products, and Subscriptions. Additionally, the following types of custom attributes are possible:
  • Text
  • Number
  • Date
  • Selection Options
  • Multiple Selection
  • List
  • Checkbox (Yes/No)

​
Use Cases

Custom attributes can be used for various purposes, such as:
  • Storing additional information about customers, such as date of birth, internal customer number, etc.
  • Storing additional information about products, such as manufacturer, weight, etc.
  • Storing additional information about subscriptions, such as contract number, etc.
  • Storing allowed features for a product on the subscription
These are just some examples of how custom attributes can be used. The usage depends on the specific requirements of your business.

​
Create Custom Attributes

1

Go to Settings > General

Scroll down to “Custom Attributes”.
2

Click on 'Create New Attribute'

Create Custom Attributes
3

Configure Attribute

Configure the attribute according to your requirements.
Configure Custom Attributes

​
Delete Custom Attributes

If you no longer need a custom attribute, you can delete it. The data will be preserved, but the attribute will no longer be displayed and cannot be edited.

​
Edit Custom Attributes

Custom attributes can be attached to customers, products, and subscriptions. These can be edited in the user interface.
Set Custom Attributes

​
Using the API

Custom attributes can also be set and retrieved via the API. Simply use the customFields field in the corresponding objects.

​
Selection Options / Multiple Selection

By default, the display name is used as the key for both value and display name. If this is not desired, when creating the custom attributes, an array can be passed under the choices point where value and display name can be defined.
Example JSON Payload
{
    "name": "My custom field",
    "slug": "custom_field",
    "type": "list",
    "choices": {
        "value1": "Display Name 1",
        "value2": "Display Name 2"
    }
}