Zuora Custom Object Definitions API
With Custom Objects service, you can define custom objects, extending the Zuora data model to accommodate your specific use cases.If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works. Click the following button to get started:[](https://www.getpostman.com/run-collection/1f068ba43651bf63c0d4)You can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup) and download the app in case you do not use Postman yet.Note that the Custom Object Definitions API is versioned by `Zuora-Version` in the request header. The response may be different for the same request with a different API version. Specify `Zuora-Version` in the request header if you expect a specific response schema.### Error handling If the Custom Objects API call fails, an error code will be returned in the response body. See [Custom Objects API error code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code) for details.
Zuora Custom Object Definitions API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Custom Object Definitions. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 5 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2023-12-15.
Requests are made against a single base URL, https://rest.zuora.com/.
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
With Custom Objects service, you can define custom objects, extending the Zuora data model to accommodate your specific use cases. If you use Postman, you can import the custom ob…
Schemas 20
The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are PostCustomObjectDefinitionsRequestDefinition (10 properties), CustomObjectDefinitionUpdateActionResponse (9 properties), CustomObjectCustomFieldDefinitionUpdate (9 properties), CustomObjectDefinitionUpdateActionRequest (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zuora 12
Other APIs Zuora publishes across the network.
This is an independent, third-party profile of Zuora Custom Object Definitions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.