Welcome to Zuora Product Documentation

Explore our rich library of product information

Create a new custom object definition

Learn how to create a new custom object definition via the Object Manager.

You should not store PCI, sensitive PII, or other regulated data in custom objects. See Responding to individual requests for access, correction, and deletion of data under applicable privacy laws for more information.

  1. Navigate to Extension Studio > Object Manager in the left navigation.
  2. Click Custom Object Actions in the upper right of the page, and then click Create New from the dropdown list.
  3. Fill in the information on the Custom Object page.
    • The Name field is required.

    • The API Name field is required.

  4. Switch the following toggles on or off to indicate whether to audit the creation or deletion of custom object records of this custom object definition. Note that you must enable the Custom Object Definition audit trail setting in your Zuora tenant before auditing custom object record creation or deletion. For more information, see Manage audit trail settings .
    • Audit Create Record

    • Audit Delete Record

  5. Click the create icon Create iconto create a custom field.
    • You must create at least one custom field for a new custom object.

    • You can add at most 50 custom fields to a custom object.

    • All custom fields in a custom object can be indexed.

  6. Input the information of the custom field on the Add New Custom Field page:
    • Name: The custom field name displayed on UI.

    • API Name: The API name of the custom field. The value must end with __c (two underscores and the letter "c") and cannot be edited once created.

    • Description: (Optional) The description of the custom field.

    • Detail: Specify field type and settings. For more information about supported field types, settings, and limitations, see Custom field types and Custom field settings.

  7. Click the Save and Add Another to save the custom field definition and immediately start creating a new custom field. Repeat until you input the information for the last new custom field. Click Save and Close to save the custom field definition and return to the new custom object page.
  8. Click Save on the new custom object page.