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": {
                   "Parent__c": {
                       "maxLength": 250,
                       "label": "Parent Company",
                       "type": "string",
                       "description": "Zuora updated description",
                       "createdDate": "2022-04-07T09:18:40.000Z",
                       "updatedDate": "2022-04-07T09:18:40.000Z"
                   },
                   "AccountOpeningtest__c": {
                       "enum": [
                           "Quaterly",
                           "Weekly",
                           "Monthly"
                       ],
                       "label": "AccountOpening",
                       "type": "string",
                       "description": "",
                       "default": "Quaterly",
                       "createdDate": "2022-04-18T08:00:45.000Z",
                       "updatedDate": "2022-04-18T08:00:45.000Z"
                   },
                   "LikesDogs__c": {
                       "enum": [
                           "Yes",
                           "No"
                       ],
                       "label": "LikesDogs",
                       "type": "string",
                       "description": "Testing description",
                       "default": "Yes",
                       "createdDate": "2022-04-07T09:18:34.000Z",
                       "updatedDate": "2022-04-07T09:18:34.000Z"
                   },
                   "PaymentCommitmentDate__c": {
                       "format": "date",
                       "label": "Payment Commitment Date",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-07T09:18:43.000Z",
                       "updatedDate": "2022-04-07T09:18:43.000Z"
                   },
                   "ConversionRate__c": {
                       "maxLength": 100,
                       "label": "Conversion Rate",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-07T09:18:18.000Z",
                       "updatedDate": "2022-04-07T09:18:18.000Z"
                   },
                   "CollectionsAgent__c": {
                       "maxLength": 255,
                       "label": "CollectionsAgent",
                       "type": "string",
                       "description": "Used for Collections Window module.",
                       "createdDate": "2022-04-07T09:18:15.000Z",
                       "updatedDate": "2022-04-07T09:18:15.000Z"
                   },
                   "Entity__c": {
                       "enum": [
                           "US",
                           "UK",
                           "NL",
                           "DE",
                           "AU"
                       ],
                       "label": "Entity",
                       "type": "string",
                       "description": "",
                       "default": "US",
                       "createdDate": "2022-04-07T09:18:25.000Z",
                       "updatedDate": "2022-04-07T09:18:25.000Z"
                   },
                   "AccountClosing_test_2__c": {
                       "maxLength": 255,
                       "label": "AccountClosing_test_2",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-18T08:00:41.000Z",
                       "updatedDate": "2022-04-18T08:00:41.000Z"
                   },
                   "InCollections__c": {
                       "enum": [
                           "False",
                           "True"
                       ],
                       "label": "InCollections",
                       "type": "string",
                       "description": "Used for Collections Window module.",
                       "default": "False",
                       "createdDate": "2022-04-07T09:18:31.000Z",
                       "updatedDate": "2022-04-07T09:18:31.000Z"
                   },
                   "APM__c": {
                       "enum": [
                           "True",
                           "False"
                       ],
                       "label": "APM",
                       "type": "string",
                       "description": "Used for Advanced Payment Manager module.",
                       "default": "True",
                       "createdDate": "2022-04-07T09:18:03.000Z",
                       "updatedDate": "2022-04-07T09:18:03.000Z"
                   },
                   "Support_Hold__c": {
                       "enum": [
                           "No",
                           "Yes"
                       ],
                       "label": "Support hold",
                       "type": "string",
                       "description": "",
                       "default": "No",
                       "createdDate": "2022-04-07T09:19:06.000Z",
                       "updatedDate": "2022-04-07T09:19:06.000Z"
                   },
                   "PortalNameURL__c": {
                       "maxLength": 255,
                       "label": "Portal Name (URL)",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-07T09:18:46.000Z",
                       "updatedDate": "2022-04-07T09:18:46.000Z"
                   },
                   "PortalRequired__c": {
                       "enum": [
                           "YES",
                           "NO"
                       ],
                       "label": "Portal Required",
                       "type": "string",
                       "description": "",
                       "default": "YES",
                       "createdDate": "2022-04-07T09:18:49.000Z",
                       "updatedDate": "2022-04-07T09:18:49.000Z"
                   },
                   "PORequired__c": {
                       "enum": [
                           "YES",
                           "NO"
                       ],
                       "label": "PO Required",
                       "type": "string",
                       "description": "",
                       "default": "YES",
                       "createdDate": "2022-04-07T09:18:36.000Z",
                       "updatedDate": "2022-04-07T09:18:36.000Z"
                   },
                   "SSPChannel__c": {
                       "enum": [
                           "Non-Reseller",
                           "Reseller"
                       ],
                       "label": "SSP Channel",
                       "type": "string",
                       "description": "Used for Revenue Recognition",
                       "default": "Non-Reseller",
                       "createdDate": "2022-04-07T09:18:55.000Z",
                       "updatedDate": "2022-04-07T09:18:55.000Z"
                   },
                   "ExcludeFromEoaStarterBronzeOffer__c": {
                       "enum": [
                           "No",
                           "Yes"
                       ],
                       "label": "Exclude from EoA Starter Bronze Offer?",
                       "type": "string",
                       "description": "",
                       "default": "No",
                       "createdDate": "2022-04-07T09:18:28.000Z",
                       "updatedDate": "2022-04-07T09:18:28.000Z"
                   },
                   "AccountCode__c": {
                       "maxLength": 100,
                       "label": "Account Code",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-07T09:18:06.000Z",
                       "updatedDate": "2022-04-07T09:18:06.000Z"
                   },
                   "CreditHold__c": {
                       "format": "date",
                       "label": "Credit Hold",
                       "type": "string",
                       "description": "Date the Customer was last placed on Credit Hold",
                       "createdDate": "2022-04-07T09:18:21.000Z",
                       "updatedDate": "2022-04-07T09:18:21.000Z"
                   },
                   "RetryStatus__c": {
                       "maxLength": 255,
                       "label": "Retry Status",
                       "type": "string",
                       "description": "h",
                       "createdDate": "2022-04-07T09:18:52.000Z",
                       "updatedDate": "2022-04-07T09:18:52.000Z"
                   }
               },
               "required": [
                   "AccountClosing_test_2__c"
               ],
               "indexed": [
                   "APM__c",
                   "AccountClosing_test_2__c",
                   "AccountCode__c",
                   "AccountOpeningtest__c",
                   "ConversionRate__c",
                   "Entity__c",
                   "ExcludeFromEoaStarterBronzeOffer__c",
                   "RetryStatus__c",
                   "SSPChannel__c"
               ],
               "additionalProperties": false
           }
       },
       "AccountingCode": {
           "type": "AccountingCode",
           "schema": {
               "type": "object",
               "properties": {
                   "AccountingCodeCustomText__c": {
                       "maxLength": 64,
                       "label": "AccountingCodeCustomText",
                       "type": "string",
                       "default": "custom text",
                       "createdDate": "2022-02-01T08:41:03.000Z",
                       "updatedDate": "2022-02-01T08:41:03.000Z"
                   },
                   "AccountingCodeCustomDate__c": {
                       "format": "date",
                       "label": "AccountingCodeCustomDate",
                       "type": "string",
                       "createdDate": "2022-02-08T07:20:15.000Z",
                       "updatedDate": "2022-02-08T07:20:15.000Z"
                   },
                   "AccountingCodeCustomPickList__c": {
                       "enum": [
                           "Alpha",
                           "Beta",
                           "Omega"
                       ],
                       "label": "AccountingCodeCustomPickList",
                       "type": "string",
                       "default": "Alpha",
                       "createdDate": "2022-02-08T07:20:18.000Z",
                       "updatedDate": "2022-02-08T07:20:18.000Z"
                   }
               },
               "additionalProperties": false
           }
       },
       "AccountingPeriod": {
           "type": "AccountingPeriod",
           "schema": {
               "type": "object",
               "properties": {
                   "Quarter__c": {
                       "enum": [
                           "Qtr1- Jan till march",
                           "Qtr2- April till June",
                           "Qtr3- July till Sept",
                           "Qtr4-Oct-Dec"
                       ],
                       "label": "Quarter",
                       "type": "string",
                       "description": "",
                       "default": "Qtr1- Jan till march",
                       "createdDate": "2021-12-15T11:22:10.000Z",
                       "updatedDate": "2021-12-15T11:22:10.000Z"
                   }
               },
               "required": [
                   "Quarter__c"
               ],
               "indexed": [
                   "Quarter__c"
               ],
               "additionalProperties": false
           }
       },
       "Amendment": {
           "type": "Amendment",
           "schema": {
               "type": "object",
               "properties": {
                   "Eff__c": {
                       "maxLength": 20,
                       "label": "Eff ",
                       "type": "string",
                       "createdDate": "2021-12-21T13:53:41.000Z",
                       "updatedDate": "2021-12-21T13:53:41.000Z"
                   }
               },
               "additionalProperties": false
           }
       },
       "Contact": {
           "type": "Contact",
           "schema": {
               "type": "object",
               "properties": {
                   "imgsrcxonmouseoveralertdomain__c": {
                       "enum": [
                           "Hi"
                       ],
                       "label": "\"><img src=x onmouseover=alert(domain)>",
                       "type": "string",
                       "description": "",
                       "default": "Hi",
                       "createdDate": "2022-04-18T08:00:55.000Z",
                       "updatedDate": "2022-04-18T08:00:55.000Z"
                   }
               },
               "indexed": [
                   "imgsrcxonmouseoveralertdomain__c"
               ],
               "additionalProperties": false
           }
       },
       "CreditBalanceAdjustment": {
           "type": "CreditBalanceAdjustment",
           "schema": {
               "type": "object",
               "properties": {
                   "SubscriptionPaymentRunId__c": {
                       "maxLength": 255,
                       "label": "Subscription Payment Run Id",
                       "type": "string",
                       "description": "",
                       "default": "255",
                       "createdDate": "2021-12-09T14:18:57.000Z",
                       "updatedDate": "2022-01-16T09:02:17.000Z"
                   }
               },
               "additionalProperties": false
           }
       },
       "CreditMemoItem": {
           "type": "CreditMemoItem",
           "schema": {
               "type": "object",
               "properties": {
                   "CreditMemoItemCustomDate__c": {
                       "format": "date",
                       "label": "CreditMemoItemCustomDate",
                       "type": "string",
                       "createdDate": "2022-01-28T11:04:08.000Z",
                       "updatedDate": "2022-01-28T11:04:08.000Z"
                   }
               },
               "additionalProperties": false
           }
       },
       "DebitMemo": {
           "type": "DebitMemo",
           "schema": {
               "type": "object",
               "properties": {
                   "RetryStatus__c": {
                       "enum": [
                           "Complete",
                           "In Progress"
                       ],
                       "label": "Retry Status",
                       "type": "string",
                       "description": "",
                       "default": "Complete",
                       "createdDate": "2021-12-09T14:19:00.000Z",
                       "updatedDate": "2021-12-15T09:14:43.000Z"
                   }
               },
               "required": [
                   "RetryStatus__c"
               ],
               "readOnlyOnUI": [
                   "RetryStatus__c"
               ],
               "additionalProperties": false
           }
       },
       "DebitTaxationItem": {
           "type": "DebitTaxationItem",
           "schema": {
               "type": "object",
               "properties": {
                   "Debit_memo_cf__c": {
                       "enum": [
                           "a",
                           "b",
                           "c",
                           "d",
                           "122312",
                           "223",
                           "22"
                       ],
                       "label": "Debit_memo_cf",
                       "type": "string",
                       "description": "test ",
                       "default": "a",
                       "createdDate": "2022-01-31T11:08:21.000Z",
                       "updatedDate": "2022-01-31T11:26:52.000Z"
                   },
                   "debit_memo_NI_cf__c": {
                       "enum": [
                           "1",
                           "2",
                           "3",
                           "4",
                           "5",
                           "aaaa"
                       ],
                       "label": "debit_memo_NI_cf",
                       "type": "string",
                       "description": "",
                       "default": "1",
                       "createdDate": "2022-01-31T11:08:59.000Z",
                       "updatedDate": "2022-01-31T11:08:59.000Z"
                   }
               },
               "required": [
                   "Debit_memo_cf__c",
                   "debit_memo_NI_cf__c"
               ],
               "indexed": [
                   "Debit_memo_cf__c"
               ],
               "additionalProperties": false
           }
       },
       "Invoice": {
           "type": "Invoice",
           "schema": {
               "type": "object",
               "properties": {
                   "RetryStatus__c": {
                       "maxLength": 255,
                       "label": "Retry Status",
                       "type": "string",
                       "createdDate": "2022-02-08T07:20:22.000Z",
                       "updatedDate": "2022-02-08T07:20:22.000Z"
                   }
               },
               "readOnlyOnUI": [
                   "RetryStatus__c"
               ],
               "additionalProperties": false
           }
       },
       "InvoiceItem": {
           "type": "InvoiceItem",
           "schema": {
               "type": "object",
               "properties": {
                   "InvoiceItemCustomDate__c": {
                       "format": "date",
                       "label": "InvoiceItemCustomDate",
                       "type": "string",
                       "createdDate": "2021-12-21T14:18:44.000Z",
                       "updatedDate": "2021-12-21T14:18:44.000Z"
                   }
               },
               "additionalProperties": false
           }
       },
       "JournalEntry": {
           "type": "JournalEntry",
           "schema": {
               "type": "object",
               "properties": {
                   "JournalEntry__c": {
                       "maxLength": 50,
                       "label": "Journal Entry ",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-18T08:01:02.000Z",
                       "updatedDate": "2022-04-18T08:01:02.000Z"
                   }
               },
               "indexed": [
                   "JournalEntry__c"
               ],
               "additionalProperties": false
           }
       },
       "OrderAction": {
           "type": "OrderAction",
           "schema": {
               "type": "object",
               "properties": {
                   "ReferringPartner__c": {
                       "maxLength": 255,
                       "label": "Referring Partner",
                       "type": "string",
                       "description": "",
                       "default": "255",
                       "createdDate": "2021-12-09T14:19:24.000Z",
                       "updatedDate": "2021-12-15T09:14:57.000Z"
                   }
               },
               "additionalProperties": false
           }
       },
       "Payment": {
           "type": "Payment",
           "schema": {
               "type": "object",
               "properties": {
                   "detailsopenontoggleconfirmcookie__c": {
                       "enum": [
                           "abcd"
                       ],
                       "label": "<details/open/ontoggle=confirm(cookie)>",
                       "type": "string",
                       "description": "",
                       "default": "abcd",
                       "createdDate": "2022-04-18T08:01:08.000Z",
                       "updatedDate": "2022-04-18T08:01:08.000Z"
                   }
               },
               "indexed": [
                   "detailsopenontoggleconfirmcookie__c"
               ],
               "additionalProperties": false
           }
       },
       "Product": {
           "type": "Product",
           "schema": {
               "type": "object",
               "properties": {
                   "BUSINESS_UNIT__c": {
                       "enum": [
                           "UnitA",
                           "UnitB"
                       ],
                       "label": "BUSINESS_UNIT",
                       "type": "string",
                       "description": "",
                       "default": "UnitA",
                       "createdDate": "2022-04-18T08:09:50.000Z",
                       "updatedDate": "2022-04-18T08:09:50.000Z"
                   },
                   "PRODUCT_FAMILY__c": {
                       "maxLength": 255,
                       "label": "PRODUCT_FAMILY",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-18T08:01:29.000Z",
                       "updatedDate": "2022-04-18T08:01:29.000Z"
                   }
               },
               "indexed": [
                   "BUSINESS_UNIT__c",
                   "PRODUCT_FAMILY__c"
               ],
               "additionalProperties": false
           }
       },
       "ProductFeature": {
           "type": "ProductFeature",
           "schema": {
               "type": "object",
               "properties": {
                   "SpecialType__c": {
                       "enum": [
                           "Feature Group",
                           "Bundle Element"
                       ],
                       "label": "Special Type",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-07T05:56:11.000Z",
                       "updatedDate": "2022-04-07T05:56:11.000Z"
                   }
               },
               "indexed": [
                   "SpecialType__c"
               ],
               "additionalProperties": false
           }
       },
       "ProductRatePlan": {
           "type": "ProductRatePlan",
           "schema": {
               "type": "object",
               "properties": {
                   "PromotionCode__c": {
                       "maxLength": 255,
                       "label": "Promotion Code",
                       "type": "string",
                       "description": "",
                       "default": "255",
                       "createdDate": "2022-01-10T04:53:14.000Z",
                       "updatedDate": "2022-04-07T09:20:16.000Z"
                   },
                   "OperatingSystem__c": {
                       "enum": [
                           "Linux",
                           "Windows",
                           "RHEL"
                       ],
                       "label": "Operating System",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-01-10T04:53:11.000Z",
                       "updatedDate": "2022-01-10T04:53:11.000Z"
                   },
                   "Frequency__c": {
                       "enum": [
                           "Perpetual",
                           "Pay as you go",
                           "Monthly",
                           "Quarterly",
                           "Annual"
                       ],
                       "label": "Frequency",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-01-10T04:53:07.000Z",
                       "updatedDate": "2022-01-10T04:53:07.000Z"
                   },
                   "Region__c": {
                       "enum": [
                           "US East",
                           "US West",
                           "EU"
                       ],
                       "label": "Region",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-01-10T04:53:17.000Z",
                       "updatedDate": "2022-01-10T04:53:17.000Z"
                   }
               },
               "indexed": [
                   "Frequency__c",
                   "OperatingSystem__c",
                   "PromotionCode__c",
                   "Region__c"
               ],
               "additionalProperties": false
           }
       },
       "ProductRatePlanCharge": {
           "type": "ProductRatePlanCharge",
           "schema": {
               "type": "object",
               "properties": {
                   "ProductRatePlanChargeCustomPickList__c": {
                       "enum": [
                           "Alpha",
                           "Beta",
                           "Omega"
                       ],
                       "label": "ProductRatePlanChargeCustomPickList",
                       "type": "string",
                       "default": "Alpha",
                       "createdDate": "2022-04-12T05:34:46.000Z",
                       "updatedDate": "2022-04-12T05:34:46.000Z"
                   },
                   "ProductRatePlanChargeCustomDate__c": {
                       "format": "date",
                       "label": "ProductRatePlanChargeCustomDate",
                       "type": "string",
                       "createdDate": "2022-04-12T05:34:41.000Z",
                       "updatedDate": "2022-04-12T05:34:41.000Z"
                   },
                   "ProductRatePlanChargeCustomText__c": {
                       "maxLength": 64,
                       "label": "ProductRatePlanChargeCustomText",
                       "type": "string",
                       "default": "custom text",
                       "createdDate": "2022-04-12T05:34:50.000Z",
                       "updatedDate": "2022-04-12T05:34:50.000Z"
                   }
               },
               "additionalProperties": false
           }
       },
       "RatePlanCharge": {
           "type": "RatePlanCharge",
           "schema": {
               "type": "object",
               "properties": {
                   "FutureDatedAmendmentGroup__c": {
                       "maxLength": 64,
                       "label": "FutureDatedAmendmentGroup",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-07T09:20:22.000Z",
                       "updatedDate": "2022-04-07T09:20:22.000Z"
                   }
               },
               "indexed": [
                   "FutureDatedAmendmentGroup__c"
               ],
               "additionalProperties": false
           }
       },
       "Refund": {
           "type": "Refund",
           "schema": {
               "type": "object",
               "properties": {
                   "detailsopenontoggleconfirmcookie__c": {
                       "enum": [
                           "abcd"
                       ],
                       "label": "<details/open/ontoggle=confirm(cookie)>",
                       "type": "string",
                       "description": "",
                       "default": "abcd",
                       "createdDate": "2022-04-18T08:02:00.000Z",
                       "updatedDate": "2022-04-18T08:02:00.000Z"
                   }
               },
               "indexed": [
                   "detailsopenontoggleconfirmcookie__c"
               ],
               "additionalProperties": false
           }
       },
       "RevenueSchedule": {
           "type": "RevenueSchedule",
           "schema": {
               "type": "object",
               "properties": {
                   "aascriptalert123script2__c": {
                       "enum": [
                           "hello"
                       ],
                       "label": "",
                       "type": "string",
                       "description": "",
                       "default": "hello",
                       "createdDate": "2022-04-18T08:02:06.000Z",
                       "updatedDate": "2022-04-18T08:02:06.000Z"
                   },
                   "aascriptalert123script__c": {
                       "enum": [
                           "hello"
                       ],
                       "label": "",
                       "type": "string",
                       "description": "",
                       "default": "hello",
                       "createdDate": "2022-04-18T08:02:10.000Z",
                       "updatedDate": "2022-04-18T08:02:10.000Z"
                   },
                   "aascriptalert2811111111292Fscript__c": {
                       "maxLength": 100,
                       "label": "",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-18T08:02:12.000Z",
                       "updatedDate": "2022-04-18T08:02:12.000Z"
                   },
                   "a__c": {
                       "maxLength": 12,
                       "label": "",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-18T08:02:03.000Z",
                       "updatedDate": "2022-04-18T08:02:03.000Z"
                   }
               },
               "indexed": [
                   "a__c",
                   "aascriptalert123script2__c",
                   "aascriptalert123script__c",
                   "aascriptalert2811111111292Fscript__c"
               ],
               "additionalProperties": false
           }
       },
       "Subscription": {
           "type": "Subscription",
           "schema": {
               "type": "object",
               "properties": {
                   "PaymentGateway__c": {
                       "maxLength": 255,
                       "label": "Payment Gateway",
                       "type": "string",
                       "createdDate": "2022-04-18T08:02:28.000Z",
                       "updatedDate": "2022-04-18T08:02:28.000Z"
                   },
                   "PaymentGateway_MC__c": {
                       "maxLength": 24,
                       "label": "Payment Gateway_MC",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-04-18T08:02:24.000Z",
                       "updatedDate": "2022-04-18T08:02:24.000Z"
                   },
                   "PaymentMethodId__c": {
                       "maxLength": 32,
                       "label": "Payment Method Id",
                       "type": "string",
                       "description": "",
                       "createdDate": "2022-01-31T05:49:43.000Z",
                       "updatedDate": "2022-04-18T08:02:31.000Z"
                   }
               },
               "indexed": [
                   "PaymentGateway_MC__c",
                   "PaymentMethodId__c"
               ],
               "additionalProperties": false
           }
       },
       "Usage": {
           "type": "Usage",
           "schema": {
               "type": "object",
               "properties": {
                   "OriginLocation__c": {
                       "maxLength": 255,
                       "label": "OriginLocation",
                       "type": "string",
                       "description": "",
                       "default": "255",
                       "createdDate": "2022-04-18T08:02:53.000Z",
                       "updatedDate": "2022-04-18T08:02:53.000Z"
                   }
               },
               "indexed": [
                   "OriginLocation__c"
               ],
               "additionalProperties": false
           }
       }
   },
   "count": 23
}