Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Calls

SOAP API Calls

The calls in the Zuora SOAP API can be thought of as functioning much like verbs do in human languages: They are the actions that you perform. In human languages, verbs act upon objects, so in this case, the API calls are the actions you perform upon the Zuora SOAP API objects.

Zuora's SOAP API offers Create, Read, Update, and Delete (CRUD) capabilities. In this API, we use the term query instead of read.

Using the SOAP API Calls

The Zuora SOAP API calls can be thought of as verbs, because they perform the CRUD actions on the API objects. Using the calls, you can perform various tasks:

  • Logging into the Zuora server  Use login call to allow you receive information for subsequent calls
  • Creating, updating, and deleting various types of information. Use the createupdate, or delete call
  • Querying account information. Use the query call

As an alternative, you can use the subscribe call, which is an all-in-one solution for creating a request to subscribe to a service.

If you have the Advanced AR Settlement feature enabled, Zuora does not support generating credit memos with the API calls.

The XML of your calls must follow this format:

  1. Header
  2. Body
  3. Operation (for example, create)
  4. Request
  5. Object name
  6. Fields for the object
  7. Additional operations

Except for the login call, use only one header per call.

Properties of the SOAP API Calls

All Zuora API calls are:

  • Service requests and responses: Using the SOAP API, your client application prepares and submits a service request to the Zuora Web service. The Web service processes that request and returns a response, which your client application handles.
  • Synchronous only (asynchronous calls are not supported): Once your client application makes a request, it waits until it receives a response from the service before taking further action.
  • Committed automatically: Every operation that writes to an object is committed automatically. This can be compared to the AUTOCOMMMIT setting in SQL. For createupdate, and delete, if you attempt to write to more than one record in an object, the write operation for each record is treated as a separate transaction. For example, if a client application attempts to create two new accounts, those accounts are created using mutually exclusive insert operations that succeed or fail individually, not as a group.

Your client applications may need to handle failures if a requested operation could not be completed.

Concurrent Request Limits

Each Zuora tenant has the following default concurrent request limits:

Type Description Default Limit for Concurrent, Uncompleted Requests Retry After
Total Request Refers to UI, REST, and SOAP API requests processed under a tenant.
  • API calls (REST and SOAP)
    • Create
    • Update
    • Get
    • Delete 
    • Generate
    • Query
  • UI requests (all - including Big Data Requests, and Big Process Requests)
  • Zuora for Salesforce
    • Zuora 360 Order Builder (includes APEX wrappers for SOAP APIs)

Excluded from this policy

  • Login API calls (REST and SOAP) 
  • UI login requests
  • Zuora for Salesforce
    • 360 Sync
    • Zuora Quotes
  • Custom requests
40 120 seconds
Big Process Request

Refers to database operation-heavy requests. The following lists the SOAP API calls and the corresponding Action calls in the Zuora API Reference that are handled as Big Process Requests and the objects they support.

create

invoice

generate

invoice

queryMore

Account

InvoiceItem

PaymentTransactionLog

RatePlan

RatePlanCharge

RatePlanChargeTier

Subscription

query

Account

Invoice

InvoicePayment

Payment

PaymentTransactionLog

RatePlan

RatePlanCharge

Subscription

Usage

20
Big Data Request Data transfers to or from Zuora, such as a usage upload or data source file download. 20

Custom

Includes all of the following:

Subscribe and amend REST method calls:

Subscribe and amend SOAP calls, and the corresponding Action calls in the Zuora API Reference:

  • Amend
  • Subscribe
  • Subscribe with existing account

Hosted Payment Method Pages:

Custom requests are not counted against the total number of requests allowed at any given time. 

200
Last modified

Tags

Classifications

(not set)