Skip to main content Skip to complementary content
Already have an account? Sign in

Zuora (v1)

Last updated: 9/15/2026

Zuora integration summary

Stitch’s Zuora integration can use one of two APIs: REST API and AQuA API. When setting up the integration in Stitch, you can choose which API to use.

Additionally, Stitch supports replicating custom fields for any object that supports custom fields in Zuora. Custom fields are supported for both the REST API and AQuA API.

Note: Each API has its benefits and limitations. For example: With the AQuA API, you can replicate large data sets and deleted records for objects that support it. Once an integration is saved, the API selected can’t be changed. Learn more about the APIs.

Refer to the Schema section for a list of objects available for replication.

Zuora feature snapshot

A high-level look at Stitch's Zuora (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on April 17, 2018

Supported by

Stitch

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-zuora

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

Supported

Select all

Supported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Zuora

Zuora setup requirements

To set up Zuora in Stitch, you need:

  • Administrator permissions in Zuora. These permissions are required to create a Zuora user (for Basic Auth) or OAuth application (for OAuth).

Step 1: Create a Stitch Zuora user

In this step, you’ll create a Zuora user for Stitch. Creating a Stitch-specific user will ensure that Stitch is distinguishable in any logs or audits.

Create the Zuora user

Zuora user permissions
Zuora user permissions

  1. Sign into your Zuora account, if you haven’t already.
  2. Click your username in the top-right corner.
  3. Click Administration, then Manage Users.
  4. Click Add Single User.
  5. Enter a first and last name for the user.
  6. Enter an email address in the Work Email field.
  7. Enter an email address in the Login Field.
  8. In the Zuora Platform Role field, select Standard User.
  9. For the remaining Role fields, select the Standard User option.
  10. There aren’t any requirements for the Locale and Language fields - leave them as the defaults.
  11. Click Save to create the user.

After the user is created, Zuora will send a verification email to the email address in the Work Email field. Complete the verification and set a password for the Stitch user before moving on to the next step.

Step 2: Add Zuora as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Zuora icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Zuora” would create a schema called stitch_zuora in the destination. Note: Schema names cannot be changed after you save the integration.

  5. If the Zuora instance you want to connect to Stitch is a sandbox, check the Connect to a Sandbox Environment checkbox.

  6. Select your authentication method using the radio button selector:
    • Basic (recommended): Use if you have created a Stitch Zuora user with username and password credentials.
    • OAuth: Use if your Zuora administrator has created an OAuth application and provided you with client ID and client secret.

    If you selected Basic (recommended):

    1. In the Zuora Username field, enter the Stitch Zuora user’s username. This is the email address that was in the Login Name field when you created the user.
    2. In the Zuora Password field, enter the password associated with the Stitch Zuora user.

    If you selected OAuth:

    1. Your Zuora administrator must create an OAuth application in Zuora to obtain the Zuora Client ID and Zuora Client Secret. If you don’t have these credentials yet, refer to Zuora documentation.

    Note: This value will be securely stored by Stitch and will not be displayed again. Keep it secure and do not share it via email or unsecured channels.

  7. If the Zuora instance you want to connect to Stitch is based in Europe, check the Connect to a European endpoint box. If you aren’t sure if this is applicable to you, refer to Zuora’s documentation.

Step 3: Select a Zuora extraction API

Stitch’s Zuora integration gives you the ability to select the API that you want Stitch to use to extract data. If you aren’t sure which API you should use, take a look at the brief comparison below.

Note: This setting can be changed at any time, but will only affect extractions that take place after the change.

Once you’ve decided, click the radio button next to the API you want to use.

REST API AQuA API
Good for replicating

Small data sets, more frequently

Large data sets, less frequently

Deleted records

Unsupported

Supported. An additional column (deleted) will be added to objects that support deletions, which indicates the record’s deletion status.

Deleted data extraction is unsupported by the AQuA API for the following objects:

  • accountingPeriod

  • contactSnapshot

  • discountAppliedMetrics

  • paymentGaterwayReconciliationEventLog

  • paymentTransactionLog

  • paymentMethodTransactionLog

  • paymentReconciliationJob

  • paymentReconciliationLog

  • processedUsage

  • refundTransactionLog

  • updaterBatch

  • updaterDetail

Refer to Zuora’s documentation for more info.

Requires additional Zuora credentials

Not required

Required. Using the AQuA API requires a Partner ID - to obtain one, reach out to Zuora Global Support.

Step 4: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Zuora integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Zuora’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 5: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Zuora integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 6: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Zuora integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab
    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Zuora, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Zuora replication

Replicate deleted data

If using the AQuA API for data extraction, deleted data will be replicated for objects that support it. Supported objects will contain a boolean column named deleted that indicates a record’s deletion status.

Note: This column won’t be automatically included for replication - it must be set to replicate.

Deleted data is supported for all objects with the exception of the following:

  • accountingPeriod

  • contactSnapshot

  • discountAppliedMetrics

  • paymentGaterwayReconciliationEventLog

  • paymentTransactionLog

  • paymentMethodTransactionLog

  • paymentReconciliationJob

  • paymentReconciliationLog

  • processedUsage

  • refundTransactionLog

  • updaterBatch

  • updaterDetail

Custom field replication

Custom object properties, or attributes, are supported by Stitch’s Zuora integration. If custom fields are available through Zuora’s API, Stitch will replicate them to your destination.

This is applicable to any object that supports custom fields in Zuora. Refer to Zuora’s documentation for info on which objects support custom fields.

Unsupported objects

Stitch’s Zuora integration doesn’t currently support replication for the following objects:

  • discountApplyDetail

  • invoiceFile

  • paymentMethodSnapshot

  • productDiscountApplyDetail

  • unitOfMeasure

Zuora table reference

Zuora object relationships

To get a better understanding of how Zuora objects relate to each other, check out Zuora’s Entity Relationship Diagram.

Understanding the relationships between different data sets will allow you to perform more in-depth and complex analyses.

Don’t see a table listed here? The list of tables shown below is not an exhaustive list of all the tables Stitch can replicate from Zuora.

We’re working on adding documentation for additional Zuora tables. If there’s a specific table you’d like to see here, let us know by opening an issue in the Stitch Docs GitHub repo.

Account

The Account table contains information about the customer accounts in your Zuora instance.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

AccountingCode

The AccountingCode table contains information about the accounting codes in your Zuora instance. Accounting codes are used to categorize transactions for accounting purposes.

Note: To replicate this table, you must have Zuora Finance enabled.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

AccountingPeriod

The AccountingPeriod table contains information about the accounting periods in your Zuora account.

Note: To replicate this table, you must have Zuora Finance enabled.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Amendment

The Amendment table contains information about subscription amendments, which are changes to customer subscriptions. For example: Changing the terms of a contract, adding/removing a product, canceling a subscription, etc.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

BillingRun

The BillingRun table contains information about billing runs.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

CommunicationProfile

The CommunicationProfile table contains information about communication profiles, which are sets of policies that determine how to communicate with the contacts associated with a specific customer account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Contact

The Contact table contains info about an account’s point-of-contact.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ContactSnapshot

The ContactSnapshot table contains ‘snapshot’ records of Bill-To or Sold-To contacts on customer accounts. Snapshots are record preservations at specific points in time. When invoices are posted, Zuora will preserve the data for the Bill-To and Sold-To contacts at that point in time.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

CreditBalanceAdjustment

The CreditBalanceAdjustment table contains information about credit balance adjustments, or the application of credit balances to invoices, payments, and refunds.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

DiscountAppliedMetrics

The DiscountAppliedMetrics table contains information about rate plan charges that use either a discount-fixed amount or discount-percentage charge model.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Export

The Export table contains information about export jobs and files.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Import

The Import table contains information about content uploads.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Invoice

The Invoice table contains info about invoices, which are bills to customers.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

InvoiceItem

The InvoiceItem table contains info about the line items in invoices.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

InvoiceItemAdjustment

The InvoiceItemAdjustment table contains info about adjustments applied to invoice line items.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

JournalEntry

The JournalEntry table contains information about

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

JournalEntryItem

The JournalEntryItem table contains information about journal entry items.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

JournalRun

The JournalRun table contains information about journal runs.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Payment

The payment table contains info about customer payments.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

PaymentRun

The PaymentRun table contains information about payment runs.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProcessedUsage

The ProcessedUsage table contains information about usage.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Product

The Product table contains info about your company’s product offerings.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProductRatePlan

The ProductRatePlan table contains info about product rate plans, or the part of a product that customers can subscribe to.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProductRatePlanCharge

The ProductRatePlanCharge table contains info about product rate plan charges, which are a charge model or set of fees associated with a product rate plan.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProductRatePlanChargeTier

The ProductRatePlanChargeTier table contains pricing info for product rate plan charges.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RatePlan

The RatePlan table contains info about rate plans, which is a price or collection of prices for services.

Custom fields

In addition to the attributes listed below, our Zuora integration will also replicate any custom fields.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RatePlanChargeTier

The RatePlanChargeTier table contains pricing info for rate plan charges.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Refund

The Refund table contains info about refunds, or transactions where money is returned to a customer.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueChargeSummaryItem

The RevenueChargeSummaryItem table contains information about charge revenue summaries, which are summaries of all revenue distributions associated with a subscription charge.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueEventItem

The RevenueEventItem table contains information about revenue events. A revenue event is a change to a revenue schedule, such as creating the initial schedule, canceling an invoice, or recognizing an undistributed amount.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueEventItemInvoiceItem

The RevenueEventItemInvoiceItem table contains information about revenue event items that are associated with invoice items.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueEventItemInvoiceItemAdjustment

The RevenueEventItemInvoiceItemAdjustment table contains information about revenue event items that are associated with invoice item adjustments.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueScheduleItem

The RevenueScheduleItem table contains information about revenue schedules. A revenue schedule represents how revenue amounts from single charges are distributed over time and recognized in accounting periods.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueScheduleItemInvoiceItem

The RevenueScheduleItemInvoiceItem table contains information about revenue schedule item - invoice items.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueScheduleItemInvoiceItemAdjustment

The RevenueScheduleItemInvoiceItemAdjustment table contains information about revenue schedule item - invoice items.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Subscription

The Subscription table contains info about your products and/or services with recurring charges.

Custom Attributes

If your Zuora subscription records contain custom attributes, Stitch will replicate them.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!