Customer organisation metadata
Attach custom key-value data to a customer organisation for internal reference and document templates.
Custom metadata lets you store extra information against a customer organisation. Use it for anything that doesn't fit the standard customer fields: ERP customer numbers, Shopify IDs, internal account codes, or any reference your team needs to track.
Metadata is managed from the customer detail page and can be included in document templates like invoices and estimates.
When to use it
| Use case | Example key | Example value |
|---|---|---|
| ERP customer ID | erp_customer_id | CUST-00412 |
| Shopify customer ID | shopify_id | 7291048302 |
| Internal account tier | account_tier | enterprise |
| Accounting contact ID | xero_contact_id | abc123-xyz |
| Requires purchase order | po_required | true |
Add a metadata entry
- Navigate to Customers from the main sidebar.
- Click the customer organisation you want to update.
- Scroll to the Metadata panel on the customer detail page.
- Click Add to open the create dialog.
- Enter a Key and a Value.
- Click Save.
Each key must be unique per organisation. If a key already exists, edit the existing entry rather than creating a new one.
Edit a metadata entry
- On the customer detail page, find the entry in the Metadata table.
- Click the edit icon on the row.
- Update the Key or Value.
- Click Save.
Delete a metadata entry
- On the customer detail page, find the entry in the Metadata table.
- Click the delete icon on the row.
- Confirm the deletion.
Deleting an entry is permanent. Any document templates that reference the deleted key will simply leave that field blank.
Use metadata in document templates
Metadata values are available inside document templates, so you can include things like a customer's ERP number on their invoices or estimates.
Open the template editor and use the Variables panel to find and insert metadata fields. For a full guide to template variables, see the Template editor writing guide.
📋 This feature was introduced in the Pricing Gates, Organisation Metadata & Storefront Billing release.
Last updated on