Custom Attributes

What they are

Custom attributes are additional fields you define at the account level that appear on every customer record. Use them to store application-specific data alongside standard customer fields — for example, a membership number, client tier, or internal account code.

Attribute types

Type	Description
string	Short text (single line)
text	Long text (multi-line)
date	Date in YYYY-MM-DD format
number	Integer or decimal number
boolean	True/false checkbox

Configuring attributes

Navigate to Settings → Customer Attributes. Attributes can be added, reordered, and removed from this screen.

You can also import and export attribute definitions as YAML — useful for replicating configuration between sandbox and live accounts.

Attribute definition fields

Field	Description
name	API key — used in code (e.g. membership_id)
label	Display name shown in the dashboard (e.g. “Membership ID”)
type	One of the types listed above
required	Whether the attribute must be set when creating a customer

Example YAML:

- name: membership_id
  label: Membership ID
  type: string
  required: true

- name: tier
  label: Customer Tier
  type: string
  required: false

- name: joined_on
  label: Joined On
  type: date
  required: false

Using attributes

Custom attributes appear on the customer create and edit forms in the dashboard. They are stored in the additional_attributes JSON field on the customer record and are searchable from the customer list.

Validation notes

Changing an attribute definition (type, required status, or removing it) does not retroactively validate or modify existing customer records. Existing data is preserved as-is. Required validation only applies to new customer creates and edits made after the configuration change.