> For the complete documentation index, see [llms.txt](https://docs.limio.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.limio.com/integrations/zuora-integration/how-to-populate-custom-fields-in-zuora/recommended-custom-fields-to-set-up-in-zuora-to-receive-enriched-limio-data.md).

# Recommended Custom Fields in Zuora

Limio recommends to implement in Zuora a set of custom fields that will automatically be populated by Limio orders. These custom fields allow Limio to pass additional information - such as metadata about the offer, customer, or context - without any manual mapping or configuration.

Limio order processing includes built-in logic to check if specific custom fields are defined in your Zuora tenant. If a supported custom field is present, Limio will automatically include it in the relevant object in the order or request payload sent to Zuora. If a field is **not defined** in Zuora, **it will not be included** in the order payload. This ensures that only valid custom fields are passed during processing.

This is different from configuring your own custom fields in Zuora and getting Limio to map to them. For this, go to 👉 [Populate Custom Fields in Zuora](/integrations/zuora-integration/how-to-populate-custom-fields-in-zuora.md)

### How to use the built-in custom field logic

To use one of the built-in custom fields in your Limio orders:

1. **Check the table below** to identify which custom field you want to use and the Zuora object it belongs to.
2. **Create the field** in your Zuora environment with the specified name (excluding the `__c` suffix).
3. **Perform a Zuora Catalog sync** in Limio to ensure the custom field becomes available.

⚠️ **Important:** Do **not** include the `__c` suffix in the custom field name when creating it in Zuora. This is appended automatically by Zuora when storing custom fields.

| Zuora Object (where the custom field needs to be defined) | Custom Field Name (Zuora custom field name) | Limio path              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| --------------------------------------------------------- | ------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Subscription                                              | CancellationReason\_\_c                     | data.reason.id          | If defined in Zuora on Subscription Fields, this field will be populated via the [cancel](https://docs.limio.com/product/self-service/what-are-the-standard-functionality-of-limio-self-service-manage-my-account/how-to-create-a-personalised-cancelsave-experience), [cancel/save](https://docs.limio.com/product/self-service/what-are-the-standard-functionality-of-limio-self-service-manage-my-account/how-to-create-a-personalised-cancelsave-experience) and [switch](https://docs.limio.com/product/self-service/what-are-the-standard-functionality-of-limio-self-service-manage-my-account/how-to-create-a-personalised-switch-upgrade-or-downgrade-experience) journeys if any cancel survey, reasons or switch component is used. |
| Debit Memo                                                | GiftCode\_c                                 |                         | If defined in Zuora on Debit Memo Fields, when a gift is purchased (by they buyer), the gift code will be populated on the debit memo created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Order                                                     | Source\_\_c                                 | order.initiated\_source | This defines where the checkout was initiated. If it was done so via Limio for Salesforce, the value would be salesforce if it were the Limio shop flow the value would be shop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Order                                                     | InitiatedSource\_\_c                        | order.source            | This defines where the event was processed. If it was done so via Limio for Salesforce, the value would be salesforce if it were the Limio shop flow the value would be shop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Offer                                                     | lmo\_offer\_\_c                             | order.offer.path        | From Release v97.0+ If defined in Zuora, this field will be populated with the url path of the limio offer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.limio.com/integrations/zuora-integration/how-to-populate-custom-fields-in-zuora/recommended-custom-fields-to-set-up-in-zuora-to-receive-enriched-limio-data.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
