Zuora Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Zuora is an enterprise software company founded in 2007 that provides a cloud-based platform for subscription management and monetization. Headquartered in Redwood City, California, it helps over 1,000 companies worldwide automate billing, revenue recognition, and digital customer relationships across various industries.

The Zuora Reader connects with the Zuora platform and reads supported objects.

Feature summary

Feature		Supported?	Notes
Objects	Standard objects	✓
Objects	Custom objects	✓
Authentication	Basic authentication		Username and password
	OAuth authentication	✓	Manual configuration based
	Custom authentication methods		Not all methods may be supported
Operations	Automated mode	✓
	Initial load	✓
	Pull-based incremental load	✓
	Push-based incremental load
	Automated pipeline
Governance	Connection profile
	Sherlock AI
	Sentinel AI
Schema handling	Initial schema creation	✓	Works with supported targets
Schema handling	Schema evolution
Setup	Wizard template
	Flow Designer	✓
	Striim TQL	✓
Runtime	Resilience/recovery	✓
	Parallel execution
	Metrics	✓	Standard metrics

Supported authentication method

The Zuora Reader supports OAuth authentication. Creating a connection requires creating a role with API write access, creating a user and assigning it the role, creating a client for the user to obtain the OAuth credentials, and setting the connection properties in Striim.

To create a connection using OAuth authentication:

Go to Settings > Manage User Roles, and create a role with API Write Access.
Create a user under Manage Users and assign the role.
Generate an OAuth Client for the user to get the Client ID and Client Secret. Save the secret securely.

To obtain access and refresh tokens from Zuora, use the following curl commands:

Authorization request

curl --request GET 'https://rest.apisandbox.zuora.com/oauth/authorize?response_type=code
&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI'

Access and refresh token request

curl --request POST 'https://rest.apisandbox.zuora.com/oauth/token' \ --header 
'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 
'grant_type=authorization_code' \ --data-urlencode 'client_id=YOUR_CLIENT_ID' \ 
--data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \ --data-urlencode 
'redirect_uri=YOUR_REDIRECT_URI' \ --data-urlencode 'code=AUTHORIZATION_CODE'

Replace YOUR_CLIENT_ID, YOUR_CLIENT_SECRET, YOUR_REDIRECT_URI, and AUTHORIZATION_CODE with your actual values.

Supported objects

The following are the supported objects for reading from Zuora:

Account
AccountingCode
AccountingPeriod
Amendment
ApplicationGroup
Attachment
BillingRun
ChargeMetrics
Contact
ContactSnapshot
CreditBalanceAdjustment
CreditMemo
CreditMemoApplication
CreditMemoApplicationItem
CreditMemoItem
CreditMemoPart
CreditMemoPartItem
CreditTaxationItem
DebitMemo
DebitMemoItem
DebitTaxationItem
DiscountAppliedMetrics
DiscountApplyDetail
FXCustomRate
Feature
Invoice
InvoiceAdjustment
InvoiceItem
InvoiceItemAdjustment
InvoicePayment
JournalEntry
JournalEntryItem
JournalRun
OrderAction
OrderElp
OrderItem
OrderMrr
OrderQuantity
OrderTcb
OrderTcv
Orders
Payment
PaymentApplication
PaymentApplicationItem
PaymentGatewayReconciliationEventLog
PaymentMethod
PaymentMethodSnapshot
PaymentMethodTransactionLog
PaymentPart
PaymentPartItem
PaymentReconciliationJob
PaymentReconciliationLog
PaymentRun
PaymentTransactionLog
ProcessedUsage
Product
ProductFeature
ProductRatePlan
ProductRatePlanCharge
ProductRatePlanChargeTier
RatePlan
RatePlanCharge
RatePlanChargeTier
Refund
RefundApplication
RefundApplicationItem
RefundInvoicePayment
RefundPart
RefundPartItem
RefundTransactionLog
RevenueChargeSummary
RevenueChargeSummaryItem
RevenueEvent
RevenueEventCreditMemoItem
RevenueEventDebitMemoItem
RevenueEventInvoiceItem
RevenueEventInvoiceItemAdjustment
RevenueEventItem
RevenueEventItemCreditMemoItem
RevenueEventItemDebitMemoItem
RevenueEventItemInvoiceItem
RevenueEventItemInvoiceItemAdjustment
RevenueEventType
RevenueSchedule
RevenueScheduleCreditMemoItem
RevenueScheduleDebitMemoItem
RevenueScheduleInvoiceItem
RevenueScheduleInvoiceItemAdjustment
RevenueScheduleItem
RevenueScheduleItemCreditMemoItem
RevenueScheduleItemInvoiceItem
RevenueScheduleItemInvoiceItemAdjustment
Subscription
SubscriptionProductFeature
TaxationItem
UpdaterBatch
UpdaterDetail
Usage
User

Zuora Reader properties

Property	Type	Default value	Notes
Client ID	String		The client ID assigned when you register your application with an OAuth authorization server.
Client secret	Password		The client secret assigned when you register your application with an OAuth authorization server.
Refresh token	Password		The OAuth refresh token for the corresponding OAuth access token. Used to refresh the OAuth access token when using OAuth authentication.
Connection pool size	Integer	20	Specifies the maximum number of active connections.
Exclude tables	String		A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.
Incremental load marker	String		The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval. Specify the name of the column that contains the start position value. This column must meet the following criteria: It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID). The values must be unique and continuously increasing to ensure proper incremental reading.
Migrate schema	Boolean	False	Only available in Initial Load or Automated mode. Set to `True` to enable initial schema migration, which propagates the object schema from the source to the target.
Mode	Select list: Automated mode Initial load Incremental load	Automated	Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.
Polling interval	Integer	5m	Specifies an interval as an integer followed by a unit. Supported units are days (`d`), hours (`h`), minutes (`m`), or seconds (`s`). The reader polls the source at the specified interval.
Start Position	String	%=-1	Value of the incremental load marker that defines the initial reading position.
Tables	String		A semicolon-delimited (;) list of objects to read from the source. Supports the `%` wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.
Thread pool count	Integer	10	The number of parallel running threads. The default value of zero specifies single-threaded operation. When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.