Implement Custom Fields

Custom fields hold the data Advanced Billing doesn't capture on its own, attached to either a Customer or a Subscription. Use this guide to create them, name them so they work for the audience that reads them, and choose which surfaces show their data.

At a glance

Feature

Custom Fields

You Need

An understanding of your business' custom fields requirements.

Code

No

Difficulty

◉◎◎◎◎

1. Create a custom field

Go to Config > Custom Fields, then click Create Custom Field and complete the form.

1. Set the Name. This name can be internal or customer-facing, depending on the field's display options. If you interact with the field programmatically, choose a name that resembles a data point, such as my_custom_field. If a person reads it, choose a name such as My Custom Field.
2. Select Attached To. Choose whether the field attaches to the Subscription, which is the most common, or the Customer.
3. Select the field type. Choose Text, Dropdown, or Radio Button. This controls how the field presents itself in the Advanced Billing admin UI, on Public Signup Pages, and in the Billing Portal.
4. Set the field options. Only for Dropdown and Radio Button fields. Add the options a user can choose from. Text fields have no options to set.
5. Set the display options. These control where the field's data appears, and are covered in the next section.

For the full reference on every field on this form, see the Configure Custom Fields help article.

2. Choose where the field data appears

A custom field holds its value whether or not anything displays it, so these options decide who actually sees it.

Custom field display options

3. Test the fields

Once you create your custom fields, test them from the perspective of both your staff and your end customers, wherever each applies. Create a subscription with custom fields, then update a subscription with custom fields, and confirm the values appear where you expect.

Show a custom field on a Public Signup Page

Displaying a custom field on a signup page is set per page, not on the field itself.

Go to Catalog > Public Signup Pages, find the product you want, click the Actions dropdown, then click Edit. Scroll to the bottom of the page and check the custom fields you want the page to display.

Related information

To switch on the invoice display option's supporting settings, see the Configure Invoices help article.