How to populate custom fields in Zuora

Zuora custom fields allow users to add additional data fields to objects like accounts, subscriptions, and invoices within the Zuora platform. These fields can be tailored to specific business needs, providing flexibility in capturing and managing unique information. Limio facilitates the population of Zuora custom fields through events such as new orders, subscription switches, and cancellations.

How to configure

1. Configure the custom field in Zuora

To enable Limio to populate custom fields, it's crucial to define them in Zuora first. Supported custom fields include those related to the following Zuora objects:

• • Subscriptions
  • Orders
  • Account.

Consult the Zuora documentation for a step-by-step guide on setting up your custom fields

It's important to note that custom fields populated by Limio or Limio for Salesforce should adhere to a specific API naming convention. The API Name must begin with ltm_ and have __c appended at the end. E.g. "ltm_fieldName__c". Field Label in Zuora however has no restriction nor impact in Limio.

Custom field defined in Zuora

For detailed insights into the full use of ltm_ tags refer to our documentation on Analytics for Tracking and Attribution.

2. Sync the Zuora Product catalog
To ensure Limio includes the custom field in the order sent to Zuora, Limio must first be aware of the custom fields defined in Zuora, and which objects they are on.

Initiate the Catalog Sync process in the Limio app. For step-by-step instructions, refer to our guide on how to Catalog Sync between Limio and Zuora.

For lmo and utm parameters, you are now done. lmo are always added via the URL. utm parameters will be added via the call to action on the referrer, for example via ?utm_content=page123.

For ltm parameters, do step 3 to 5.

3. (ltm parameters only) Add the custom attribute to the template

To define custom attributes in Limio, follow this guide on How to create new custom attributes. In order for the custom attribute to be passed to Zuora they must match the API without "__c" appended on the end. You do not need to put information about the Zuora object.

Please be mindful that these attributes are case-sensitive. Refer to the example below for clarification:


Custom field defined on the Limio Template

4.(ltm parameters only) Add the custom field to the page/offer

Once added to the relevant offer/page template, the new field will appear on offers/pages using that template. You can then simply enter the desired field value and save the page.

5.(ltm parameters only) Publish the page

Changes will only be reflected on new events after the relevant pages have been published.

OOTB custom fields

Some custom fields come pre-configured and don't require setup in Limio. As long as these fields are defined in Zuora, they will automatically be populated. Explore further details in our guide on Out-Of-The-Box Zuora Custom Fields.

Date type custom fields

To utilize date functionality as a custom field in Zuora for purposes like defining a delayed subscription start date, follow these steps:

1.Define the custom field in Zuora, selecting "Data Type: Date."
2. In the Limio template, define the custom field as "Type: string."
3. When specifying the custom field value, input a string in the format YYYY-MM-DD.

By adhering to these steps, the custom field will be captured as a date in Zuora, displayed according to the format defined in your Zuora settings.