SOAP API
SOAP is a mature, XML-based protocol for connecting applications and servers to web-based back-end services. Typical SOAP solutions involve desktop applications, enterprise servers, or public-facing web products.
The Zuora SOAP API provides fully fleshed-out support for virtually everything you can do in the Zuora UI. Thirty SOAP objects provide access to the entire Zuora functional suite, including accounts and contacts, products, rate plans, subscriptions, amendments, invoices, payments, refunds, credit balance adjustments, accounting periods, and much more.
The SOAP API provides this fine-grained level of control by exposing the entire Zuora object model and allowing you to make create(), read(), update(), and delete() calls on those objects. As such, in contrast to the use case-oriented REST API, you will need to understand the Zuora object model to become proficient with the SOAP API.
If your integration use cases extend beyond building web self-service storefront integrations, then the SOAP API is likely the right fit for your business.
- Getting Started with the SOAP API
- Provides a checklist for getting started with SOAP API
- Coding Overview
- Introduces you to Zuora coding best practices when building your client applications
- Use Cases and Code Samples
- Provides a list use cases that will show you how to create, update, cancel, and query objects using SOAP calls.
- SOAP API Object Relationships
- Describes the Zuora API Object relationships and includes a diagram of these relationships
- SOAP API Object Reference
- Lists all supported SOAP API objects
- Field Types
- Objects and Their Supported Calls
- Account
- AccountingCode
- AccountingPeriod
- Amendment
- BillingPreviewRun
- BillRun
- Communication Profile
- Contact
- ContactSnapshot
- CreditBalanceAdjustment
- DiscountApplyDetail
- Export
- Feature
- Import
- Invoice
- InvoiceAdjustment
- InvoiceFile
- InvoiceItem
- InvoiceItemAdjustment
- InvoicePayment
- InvoiceSplit
- InvoiceSplitItem
- PaymentMethod
- PaymentMethodSnapshot
- Payment object
- Product
- ProductDiscountApplyDetail
- ProductFeature
- ProductRatePlan
- ProductRatePlanCharge
- ProductRatePlanChargeTier
- RatePlan
- RatePlanCharge
- RatePlanChargeTier
- RefundInvoicePayment
- Refund object
- Subscription
- SubscriptionProductFeature
- TaxableItemSnapshot
- TaxationItem
- UnitOfMeasure
- Usage
- zObject
- SOAP API Calls
- Describes SOAP API calls, actions that you can perform on Zuora objects. Provides an overview on usage and limits
- SOAP API Complex Types
- Provides a list of supported SOAP objects known as complex types that are used to group attributes, set values, and read results of call actions
- AmendOptions
- AmendRequest
- AmendResult
- BillingPreviewRequest
- BillingPreviewResult
- CallOptions
- ChargeMetricsData
- DeleteResult
- InvoiceData
- InvoiceProcessingOptions
- LoginResult
- PreviewOptions
- QueryOptions
- QueryResult
- RatePlanChargeData
- RatePlanData
- SaveResult
- SessionHeader
- SubscribeOptions
- SubscribeRequest
- SubscribeResult
- SubscribeWithExistingAccountRequest
- SubscriptionData
- SubscriptionProductFeatureList
- Zuora SOAP API Version History
- Documents the schema changes introduced in each version of Zuora SOAP WSDL, starting from the second half of 2015.