Skip to main content

View all custom fields

Zuora

View all custom fields

To retrieve all the custom fields for Zuora standard objects, see the following request and a sample of 200 response.

HTTP request:

GET https://rest.zuora.com/settings/custom-fields/zuora

Response body:

{
  "definitions": {
    "Account": {
      "type": "Account",
      "schema": {
        "type": "object",
        "properties": {
          "Territory__c": {
            "enum": [
              "Undefined",
              "Central",
              "North",
              "South",
              "East",
              "West"
            ],
            "label": "Territory",
            "type": "string",
            "description": "The territory in which the account belongs in. This is used to enhance reporting.",
            "default": "Undefined",
            "createdDate": "2015-01-09T22:25:30.000Z",
            "updatedDate": "2015-01-09T23:15:22.000Z"
          },
          "SEUseCase__c": {
            "maxLength": 255,
            "label": "SE Use Case",
            "type": "string",
            "description": "Allows the ability to quickly search accounts to demonstrate use cases to clients.",
            "default": "",
            "createdDate": "2015-01-07T15:30:04.000Z",
            "updatedDate": "2015-01-07T15:31:27.000Z"
          },
          "InvoiceNumber__c": {
            "enum": [
              "dddd"
            ],
            "label": "Invoice Number",
            "type": "string",
            "description": "",
            "default": "dddd",
            "createdDate": "2019-10-04T21:10:01.000Z",
            "updatedDate": "2019-10-04T21:10:01.000Z"
          },
          "AccountStructure__c": {
            "enum": [
              "Public",
              "Private",
              "Wholly Owned Subsidiary",
              "VC Backed",
              "State and Local Govt",
              "Federal"
            ],
            "label": "Account Structure",
            "type": "string",
            "description": "Field used to support custom reporting and analysis.",
            "createdDate": "2015-01-09T22:33:11.000Z",
            "updatedDate": "2015-01-09T22:33:11.000Z"
          },
          "AccountProfile__c": {
            "enum": [
              "Small",
              "Medium",
              "Enterprise",
              "Strategic",
              "Growth"
            ],
            "label": "Account Profile",
            "type": "string",
            "description": "Custom field to support reporting by account type.",
            "default": "Small",
            "createdDate": "2015-01-09T22:30:56.000Z",
            "updatedDate": "2015-01-09T22:31:22.000Z"
          },
          "Entity__c": {
            "enum": [
              "North America",
              "EMEA",
              "APAC"
            ],
            "label": "Entity",
            "type": "string",
            "description": "",
            "default": "North America",
            "createdDate": "2014-12-26T17:13:00.000Z",
            "updatedDate": "2014-12-26T17:13:00.000Z"
          }
        },
        "indexed": [
          "AccountProfile__c",
          "AccountStructure__c",
          "Entity__c",
          "InvoiceNumber__c",
          "SEUseCase__c",
          "Territory__c"
        ],
        "additionalProperties": false
      }
    },
    "AccountingPeriod": {
      "type": "AccountingPeriod",
      "schema": {
        "type": "object",
        "properties": {
          "dddd__c": {
            "maxLength": 12,
            "label": "dddd",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2019-08-09T19:49:56.000Z",
            "updatedDate": "2019-08-09T19:49:56.000Z"
          }
        },
        "indexed": [
          "dddd__c"
        ],
        "additionalProperties": false
      }
    },
    "Product": {
      "type": "Product",
      "schema": {
        "type": "object",
        "properties": {
          "UpgradePathSKU__c": {
            "maxLength": 255,
            "label": "Upgrade Path (SKU)",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-29T19:55:00.000Z",
            "updatedDate": "2014-12-29T19:55:00.000Z"
          },
          "SaaSProductFamily__c": {
            "enum": [
              "Software",
              "Storage",
              "Bundle"
            ],
            "label": "SaaS Product Family",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-24T16:23:25.000Z",
            "updatedDate": "2014-12-24T16:23:25.000Z"
          },
          "Inventory__c": {
            "maxLength": 255,
            "label": "Inventory",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-29T16:12:11.000Z",
            "updatedDate": "2014-12-29T16:12:11.000Z"
          },
          "SoftwareProductFamily__c": {
            "enum": [
              "Creation",
              "Design",
              "Simulation",
              "Maintenance"
            ],
            "label": "Software Product Family",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-23T23:12:59.000Z",
            "updatedDate": "2015-01-10T00:34:48.000Z"
          },
          "ContextFilter__c": {
            "enum": [
              "ControlSystem_PowerSupply"
            ],
            "label": "Context Filter",
            "type": "string",
            "description": "",
            "createdDate": "2015-01-21T10:19:39.000Z",
            "updatedDate": "2015-01-21T10:19:39.000Z"
          },
          "Prospect__c": {
            "maxLength": 255,
            "label": "Prospect",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2015-11-19T23:27:14.000Z",
            "updatedDate": "2015-11-19T23:27:14.000Z"
          },
          "DowngradePathSKU__c": {
            "maxLength": 255,
            "label": "Downgrade Path (SKU)",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-29T19:55:17.000Z",
            "updatedDate": "2014-12-29T19:55:17.000Z"
          },
          "RoadmapPriority__c": {
            "enum": [
              "1 - High",
              "2",
              "3",
              "4",
              "5 - Low"
            ],
            "label": "Roadmap Priority",
            "type": "string",
            "description": "Custom field used to support reporting and analysis.",
            "createdDate": "2015-01-09T22:37:01.000Z",
            "updatedDate": "2015-01-09T22:41:04.000Z"
          },
          "ProductManager__c": {
            "enum": [
              "Dan Swanson",
              "Sandy Taylor",
              "Bruce Wilson",
              "Deb Johnson",
              "Mary Swanson"
            ],
            "label": "Product Manager",
            "type": "string",
            "description": "",
            "default": "Dan Swanson",
            "createdDate": "2015-01-09T22:43:00.000Z",
            "updatedDate": "2015-01-09T22:43:00.000Z"
          },
          "HardwareProductFamily__c": {
            "enum": [
              "Device",
              "Accessory"
            ],
            "label": "Hardware Product Family",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-24T00:21:29.000Z",
            "updatedDate": "2014-12-24T18:51:06.000Z"
          },
          "PartnerCommission__c": {
            "maxLength": 3,
            "label": "Partner Commission %",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2015-02-06T16:37:22.000Z",
            "updatedDate": "2015-02-06T16:37:22.000Z"
          },
          "PaaSProductFamily__c": {
            "enum": [
              "General Purpose",
              "Compute Optimized",
              "Memory Optimized",
              "Storage Optimized"
            ],
            "label": "PaaS Product Family",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-24T17:08:12.000Z",
            "updatedDate": "2014-12-24T18:22:04.000Z"
          },
          "ProductCategory__c": {
            "enum": [
              "Base Product",
              "Add-On Product",
              "Professional Services",
              "Miscellaneous"
            ],
            "label": "Product Category",
            "type": "string",
            "description": "",
            "createdDate": "2015-01-09T19:19:13.000Z",
            "updatedDate": "2015-01-13T16:16:42.000Z"
          },
          "AddOnGroup__c": {
            "enum": [
              "All",
              "SaaS",
              "Software"
            ],
            "label": "Add On Group",
            "type": "string",
            "description": "",
            "createdDate": "2015-01-13T05:37:42.000Z",
            "updatedDate": "2015-01-13T05:37:42.000Z"
          }
        },
        "indexed": [
          "DowngradePathSKU__c",
          "HardwareProductFamily__c",
          "Inventory__c",
          "PaaSProductFamily__c",
          "ProductCategory__c",
          "ProductManager__c",
          "RoadmapPriority__c",
          "SaaSProductFamily__c",
          "SoftwareProductFamily__c",
          "UpgradePathSKU__c"
        ],
        "additionalProperties": false
      }
    },
    "ProductFeature": {
      "type": "ProductFeature",
      "schema": {
        "type": "object",
        "properties": {
          "SpecialType__c": {
            "enum": [
              "Feature Group",
              "Bundle Element"
            ],
            "label": "Special Type",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-29T19:05:13.000Z",
            "updatedDate": "2015-01-14T17:50:58.000Z"
          }
        },
        "indexed": [
          "SpecialType__c"
        ],
        "additionalProperties": false
      }
    },
    "ProductRatePlan": {
      "type": "ProductRatePlan",
      "schema": {
        "type": "object",
        "properties": {
          "PromotionCode__c": {
            "maxLength": 255,
            "label": "Promotion Code",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-23T19:17:56.000Z",
            "updatedDate": "2014-12-23T19:17:56.000Z"
          },
          "OperatingSystem__c": {
            "enum": [
              "Linux",
              "Windows",
              "RHEL"
            ],
            "label": "Operating System",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-24T17:10:17.000Z",
            "updatedDate": "2014-12-24T17:10:17.000Z"
          },
          "Region__c": {
            "enum": [
              "US East",
              "US West",
              "EU"
            ],
            "label": "Region",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-24T17:10:51.000Z",
            "updatedDate": "2014-12-24T17:10:51.000Z"
          },
          "Frequency__c": {
            "enum": [
              "Perpetual",
              "Pay as you go",
              "Monthly",
              "Quarterly",
              "Annual"
            ],
            "label": "Frequency",
            "type": "string",
            "description": "",
            "createdDate": "2014-12-24T18:24:16.000Z",
            "updatedDate": "2014-12-29T16:56:56.000Z"
          }
        },
        "indexed": [
          "Frequency__c",
          "OperatingSystem__c",
          "PromotionCode__c",
          "Region__c"
        ],
        "additionalProperties": false
      }
    },
    "RatePlanCharge": {
      "type": "RatePlanCharge",
      "schema": {
        "type": "object",
        "properties": {
          "FutureDatedAmendmentGroup__c": {
            "maxLength": 64,
            "label": "FutureDatedAmendmentGroup",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2015-11-13T22:53:12.000Z",
            "updatedDate": "2015-11-13T22:54:06.000Z"
          }
        },
        "indexed": [
          "FutureDatedAmendmentGroup__c"
        ],
        "additionalProperties": false
      }
    },
    "Refund": {
      "type": "Refund",
      "schema": {
        "type": "object",
        "properties": {
          "dddd__c": {
            "maxLength": 255,
            "label": "dddd",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2019-10-04T21:10:52.000Z",
            "updatedDate": "2019-10-04T21:10:52.000Z"
          }
        },
        "indexed": [
          "dddd__c"
        ],
        "additionalProperties": false
      }
    },
    "Subscription": {
      "type": "Subscription",
      "schema": {
        "type": "object",
        "properties": {
          "PartnerID__c": {
            "maxLength": 255,
            "label": "PartnerID",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2015-02-06T16:35:40.000Z",
            "updatedDate": "2015-02-06T16:35:40.000Z"
          },
          "OpportunityID__c": {
            "maxLength": 18,
            "label": "Opportunity ID",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2015-02-05T23:50:49.000Z",
            "updatedDate": "2015-02-05T23:50:49.000Z"
          },
          "QuoteID__c": {
            "maxLength": 18,
            "label": "Quote ID",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2015-02-05T23:51:03.000Z",
            "updatedDate": "2015-02-05T23:51:03.000Z"
          },
          "RiskProfile__c": {
            "enum": [
              "1 - Low",
              "2",
              "3",
              "4",
              "5 - High"
            ],
            "label": "Risk Profile",
            "type": "string",
            "description": "Field used to capture current risk of subscription churning. This can be used in conjunction when tracking non billable usage.",
            "default": "1 - Low",
            "createdDate": "2015-01-09T22:28:54.000Z",
            "updatedDate": "2015-01-09T23:16:33.000Z"
          },
          "Source__c": {
            "enum": [
              "Web",
              "Referral",
              "Sales Inbound",
              "Sales Outbound",
              "Marketing Event"
            ],
            "label": "Source",
            "type": "string",
            "description": "Custom field to support additional reporting and analysis.",
            "default": "Web",
            "createdDate": "2015-01-09T22:35:24.000Z",
            "updatedDate": "2015-01-09T23:16:13.000Z"
          }
        },
        "indexed": [
          "OpportunityID__c",
          "PartnerID__c",
          "QuoteID__c",
          "RiskProfile__c",
          "Source__c"
        ],
        "additionalProperties": false
      }
    },
    "Usage": {
      "type": "Usage",
      "schema": {
        "type": "object",
        "properties": {
          "Duration__c": {
            "maxLength": 255,
            "label": "Duration",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-23T21:47:36.000Z",
            "updatedDate": "2014-12-23T21:47:36.000Z"
          },
          "DurationUOM__c": {
            "maxLength": 255,
            "label": "Duration UOM",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-23T21:47:45.000Z",
            "updatedDate": "2014-12-23T21:47:45.000Z"
          },
          "Type__c": {
            "maxLength": 255,
            "label": "Type",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-23T21:47:10.000Z",
            "updatedDate": "2014-12-23T21:47:10.000Z"
          },
          "Activity__c": {
            "maxLength": 255,
            "label": "Activity",
            "type": "string",
            "description": "",
            "default": "",
            "createdDate": "2014-12-23T21:47:18.000Z",
            "updatedDate": "2014-12-23T21:47:18.000Z"
          }
        },
        "indexed": [
          "Activity__c",
          "DurationUOM__c",
          "Duration__c",
          "Type__c"
        ],
        "additionalProperties": false
      }
    }
  },
  "count": 9
}