> This page is for Docs.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Overview of Settings API

> Settings API allows you to automate your tenant settings management process.

Settings API allows you to automate your tenant settings management process.

With Settings API, you can programmatically:

* Retrieve a list of all the available settings in your tenant
* Read a setting value
* Update a setting value
* Process batch settings request

You can also leverage this API to clone settings from one tenant to another.

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:

[](https://app.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.

## List all settings

You can make a [List all settings](https://developer.zuora.com/v1-api-reference/api/operation/GET_ListAllSettings/) call to obtain all the available settings in your tenant. All the information you need to read or update a setting item is returned in the successful response of this API operation, including:

* Descriptions of all the settings
* The available endpoint of every setting item
* Supported HTTP methods of every endpoint
* Parameters of every operation, for example, path parameter, header parameter, and so on
* Request and/or Response schemas of every operation

See [ListAllSettingsResponseSample.json](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.json) for a 200 response sample of the "List all Settings" operation.

For common use cases of Settings API, see [Settings API tutorials](/docs/platform/system-management/settings-api/settings-api-tutorials).

## Batch request

Zuora Settings API supports batch requests. With the batch request operation, you can batch several Settings API calls into a single HTTP request to minimize the number of HTTP connections in case you need to accomplish a large volume of Settings updates in a limited time.

See [Submit settings requests](https://developer.zuora.com/v1-api-reference/api/operation/POST_ProcessSettingsBatchRequest/) in Zuora API Reference for more information.

## Supported settings

See the following table for the supported settings in Settings API.

<table>
  <tr>
    <th>
      Section
    </th>

    <th>
      Settings
    </th>

    <th>
      Supported?
    </th>
  </tr>

  <tr>
    Administration

    <td>
      Security Policies
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage User Roles
    </td>

    <td>
      View Only
    </td>
  </tr>

  <tr>
    <td>
      Manage Users
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      Manage Tenant Profile
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Data Access Control
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      AQuA Stateful Time Offset
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      External SMTP
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    Billing

    <td>
      Define Default Subscription Settings
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Customize Units Of Measure
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Customize Currencies
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Custom Fields
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Define Billing Periods
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Define Billing Rules
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Define Numbering and SKU Formats
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Enable Charge Types / Models
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Billing Document Configuration
    </td>

    <td>
      Yes

      (Document Configuration for Credit Memo and Debit Memo is supported only when Invoice Settlement is enabled)
    </td>
  </tr>

  <tr>
    <td>
      Manage Revenue Recognition Codes
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Payment Terms
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Download the Zuora WSDL
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      Setup Taxation Codes
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Setup External Tax Engine
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      Customize Batch Names
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Define Discount Settings
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Callout Options
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    Payments

    <td>
      Payment Method
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Setup Payment Gateway
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Configure Payment Retry Rules
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Setup Payment Method Updater
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      Setup Payment Page and Payment Link
    </td>

    <td>
      Yes (New token and page id will be generated)
    </td>
  </tr>

  <tr>
    <td>
      Manage Custom Fields
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Define Payment Rules
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Configure Reason Codes
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      CIT/MIT Configuration
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      Configure Application Rule
    </td>

    <td>
      Yes (Only when Invoice Settlement is enabled)
    </td>
  </tr>

  <tr>
    Commerce

    <td>
      Synchronize Salesforce.com Data
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      Configure Salesforce.com Quote Templates
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Checkout Pages
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    Finance

    <td>
      Manage Custom Fields
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Configure Aging Balance Settings
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Configure Accounting Codes
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      Configure Accounting Rules
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Currency Conversion
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Set Revenue Automation Start Date
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Configure Revenue Event Types
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Revenue Recognition Models
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Configure Segments
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Configure GL Segmentation Rules
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Revenue Recognition Rules
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Manage Chart of Accounts
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    Reporting

    <td>
      Manage Datasources
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    <td>
      AQuA job finder
    </td>

    <td>
      No
    </td>
  </tr>

  <tr>
    Multi-Entity Settings

    <td>
      Inbound Entity Connections
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Outbound Entity Connections
    </td>

    <td>
      Yes
    </td>
  </tr>

  <tr>
    <td>
      Product Attribute Control Level Setup (Sharing Attribute)
    </td>

    <td>
      Yes
    </td>
  </tr>
</table>

## Limitations

The Settings API currently does not support the following categories of settings:

* User role creation and updates
* User management API
* Email templates