Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Settings API

The Setting API provides a central API for managing settings in your Zuora tenant.If you use Postman, you can import the Settings API 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:[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.getpostman.com/run-collection/1379901-d43e93a3-7d51-437c-b4cd-14163dd62fa2-SWLk4kiK)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.

Zuora Settings API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

2 operations 2 paths 12 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Settings 2

The Setting API provides a central API for managing settings in your Zuora tenant. If you use Postman, you can import the Settings API endpoints as a collection into your Postman…

GET
/settings/listing
List all settings
GET_ListAllSettings 7 params → 200
POST
/settings/batch-requests
Submit settings requests
POST_ProcessSettingsBatchRequest 8 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SettingItemHttpOperation (5 properties), SettingItemWithOperationsInformation (5 properties), SettingValueRequest (5 properties), ChildrenSettingValueRequest (4 properties). Each schema is shown below with its type and property counts.

SettingsBatchResponse
object
1 property
SettingItemHttpRequestParameter
object
2 properties
SettingValueResponseWrapper
object
4 properties
SettingValueResponse
object
3 properties
ChildrenSettingValueRequest
object
4 properties
BodyInSettingValueReponse
object
Response body if the request is executed successfully.
BodyInSettingValueRequest
object
Request payload if any
SettingsBatchRequest
object
1 property
SettingItemWithOperationsInformation
object
5 properties
SettingItemHttpOperation
object
5 properties
SettingValueRequest
object
5 properties
ListAllSettingsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-settings-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API