Welcome to Zuora Product Documentation

Explore our rich library of product information

Objects that support custom fields in Zuora

This reference lists objects that supports custom fields, and also objects that support setting and retrieving custom field values via API operations.

Objects that support creating custom fields from Zuora UI

Zuora enables you to create custom fields in the following objects from the Zuora UI:

  • Orders objects:

    • Order

    • Order Action

    • Order Line Item

  • Billing objects:

    • Account

    • Amendment

    • Contact

    • Subscription

    • Product

    • Feature

    • Price Book Item

    • Product Rate Plan

    • Product Rate Plan Charge

    • Subscription Rate Plan

    • Subscription Rate Plan Charge

    • Product Feature

    • Subscription Product Feature

    • Invoice Item Adjustment

    • Invoice Adjustment (This object is deprecated on Production)

    • Invoice

    • Invoice Item ("Invoice Detail")

    • Credit Memo

    • Debit Memo

    • Credit Memo Item

    • Debit Memo Item

    • Taxation Item ("Invoice Tax")

    • Credit Memo Taxation Item ("Credit Memo Tax")

    • Debit Memo Taxation Item ("Debit Memo Tax")

    • Usages

  • Payments objects:

    • Refund

    • Payment

    • Payment Method

    • Credit Balance Adjustment

    • Payment Schedule

    • Payment Schedule Item

  • Finance objects:

    • Accounting Period

    • Accounting Code

    • Revenue Schedule

    • Revenue Event

    • Journal Entry

    • Journal Entry Item

    • Revenue Event Item

    • Revenue Schedule Item

You can also set values to the custom fields in these objects.

Note that for the custom field defined in Zuora Billing that has revenue impact, after the object data has synced to Zuora Revenue, any update to the custom fields in Zuora Billing cannot be automatically interfaced to Zuora Revenue.

Objects that support setting values to custom fields

After creating a custom field in the Zuora UI, you can set the value to this field using either UI or API. Setting values to custom fields is available to all the listed objects from the Zuora UI, but is restricted to only some objects via API.

The following table describes the mapping relationship between objects and the supported custom field operations via API:

Object

Set value to custom fields via API

Retrieve value of custom fields via API

Order

Check mark

Check mark

Order Action

Check mark

Check mark

Account

Check mark

Check mark

Amendment

Check mark

Check mark

Contact

Check mark

Check mark

Contact Snapshot

Check mark

Subscription

Check mark

Check mark

Product

Check mark

Check mark

Feature

Check mark

Check mark

Price Book Item

Product Rate Plan

Check mark

Check mark

Product Rate Plan Charge

Check mark

Check mark

Subscription Rate Plan

Check mark

Check mark

Subscription Rate Plan Charge

Check mark

Check mark

Product Feature

Check mark

Subscription Product Feature

Check mark

Invoice Item Adjustment

Check mark

Check mark

Invoice Adjustment (This object is deprecated on Production)

Check mark

Check mark

Invoice

Check mark

Check mark

Invoice Item ("Invoice Detail")

Check mark

Check mark

Credit Memo

Check mark

Check mark

Debit Memo

Check mark

Check mark

Credit Memo Item

Check mark

Check mark

Debit Memo Item

Check mark

Check mark

Taxation Item ("Invoice Tax")

Check mark

Check mark

Credit Memo Taxation Item ("Credit Memo Tax")

Check mark

Debit Memo Taxation Item ("Debit Memo Tax")

Check mark

Usage

Check mark

Check mark

Refund

Check mark

Check mark

Payment

Check mark

Check mark

Credit Balance Adjustment

Check mark

Check mark

Payment Method

Check mark

Check mark

Accounting Period

Check mark

Check mark

Accounting Code

Check mark

Check mark

Revenue Schedule

Check mark

Check mark

Revenue Event

Check mark

Check mark

Journal Entry

Check mark

Check mark

Journal Entry Item

Check mark

Check mark

Revenue Event Item

Check mark

Check mark

Revenue Schedule Item

Check mark

Check mark