Skip to main content

Overview of Settings API

Zuora

Overview of Settings API

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.

List all settings

You can make a List all settings 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 List all Settings, 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 for a 200 response sample of the "List all Settings" operation.

For common use cases of Settings API, see Tutorial of Settings API.

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 multiple settings requests as a batch in Zuora API Reference for more information.

Limitations

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

  • User Role creation and updates.
  • User Management API.
  • Email Templates. Instead, you can create, update, get or delete an email template or query email templates through the notifications API. See the details of all the email template operations in the Notifications API.

Supported Settings

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

Section Settings Supported?

Administration

 

Security Policies

Yes

Manage User Roles

View Only

Manage Users

No

Manage Tenant Profile

Yes

Manage Data Access Control

Yes

AQuA Stateful Time Offset

No

External SMTP

Yes

Billing

Define Default Subscription Settings

Yes

Customize Units Of Measure

Yes

Customize Currencies

Yes

Manage Custom Fields

No

Define Billing Periods

Yes

Define Billing Rules

Yes

Define Numbering and SKU Formats

Yes

Enable Charge Types / Models

Yes

Manage Billing Document Configuration

Yes

(Document Configuration for Credit Memo and Debit Memo is supported only when Invoice Settlement is enabled)

Manage Revenue Recognition Codes

Yes

Payment Terms

Yes

Download the Zuora WSDL

No

Setup Taxation Codes

Yes

Setup External Tax Engine

No

Setup Profiles, Notifications and Email Templates

Yes (Exception: Email Templates)

Customize Batch Names

Yes

Define Discount Settings

Yes

Callout Options No

Payments

Payment Method

Yes

Setup Payment Gateway

Yes

Setup Profiles, Notifications and Email Templates

Yes

(Exception: Email Templates)

Configure Payment Retry Rules

Yes

Setup Payment Method Updater

No

Setup Hosted Pages

Yes (New token and page id will be generated)

Manage Custom Fields

No

Configure Reason Codes

Yes

CIT/MIT Configuration

No

Configure Application Rule

Yes (Only when Invoice Settlement is enabled)

Commerce

Synchronize Salesforce.com Data

No

Configure Salesforce.com Quote Templates

Yes

Manage Checkout Pages

No

Finance

Manage Custom Fields

No

Configure Aging Balance Settings

Yes

Configure Accounting Codes

No

Configure Accounting Rules

Yes

Setup Profiles, Notifications and Email Templates

Yes (Exception: Email Templates)

Manage Currency Conversion

Yes

Set Revenue Automation Start Date

Yes

Configure Revenue Event Types

Yes

Manage Revenue Recognition Models

Yes

Configure Segments

Yes

Configure GL Segmentation Rules

Yes

Manage Revenue Recognition Rules

Yes

Manage Chart of Accounts

Yes

Reporting

Manage Datasources

No

AQuA job finder

No

Multi-Entity Settings Inbound Entity Connections Yes
Outbound Entity Connections Yes
Product Attribute Control Level Setup (Sharing Attribute) Yes