This integration is powered by Singer's Zuora tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
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.0) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release Status |
Released |
Supported By | |
| Stitch Plan |
Paid |
Singer GitHub Repository | |
| DATA SELECTION | |||
| Table Selection |
Supported |
Column Selection |
Supported |
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Unsupported |
| Table-level Reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Zuora
Zuora setup requirements
To set up Zuora in Stitch, you need:
- A paid Stitch plan. While those currently in the Free Trial will also be able to set up Zuora, replication will be paused until a paid plan is selected after the trial ends.
-
Administrator permissions in Zuora. These permissions are required to create a Zuora user for Stitch.
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.
Important: Zuora user requirements
To replicate your Zuora data, Stitch requires a user that:
- Has Standard user permissions. While Stitch will only ever read your data, these permissions are required to access certain objects in Zuora.
- Has two-factor authentication disabled. If this is enabled, connection and replication issues will occur after setup. Refer to the Disable or Reset Two-Factor Authentication section in this Zuora documentation for help disabling this setting.
- Has credentials that don’t expire. This is applicable only if your company enforces Password Expiration rules. If Stitch’s Zuora credentials expire, connection issues may arise. Refer to this Zuora support article for a workaround.
Create the Zuora user
- Sign into your Zuora account, if you haven’t already.
- Click your username in the top-right corner.
- Click Administration, then Manage Users.
- Click Add Single User.
- Enter a first and last name for the user.
- Enter an email address in the Work Email field.
- Enter an email address in the Login Field.
- In the Zuora Platform Role field, select Standard User.
- For the remaining Role fields, select the Standard User option.
- There aren’t any requirements for the Locale and Language fields - leave them as the defaults.
- 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
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Zuora icon.
-
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_zuorain the destination. Note: Schema names cannot be changed after you save the integration. - If the Zuora instance you want to connect to Stitch is a sandbox, check the Connect to a Sandbox Environment checkbox.
- In the 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.
- In the Password field, enter the password associated with the Stitch Zuora user.
- If the Zuora instance you want to connect to Stitch is a sandbox, check the Connect to a Sandbox Environment box.
- 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 data extraction is unsupported by the AQuA API for the following objects:
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 sync
The Sync Historical Data setting will define 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 tables and columns to replicate
To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.
Check out the Schema section to learn more about the available tables in Zuora and how they replicate.
- In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.
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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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 schemas
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1.0 of this integration.
This is the latest version of the Zuora integraiton.
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.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
account
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
updatedDate |
Primary Key  :
|
id |
Official docs : |
The account table contains information about the customer accounts in your Zuora instance.
|
id
The account ID. Reference: |
|
updatedDate
The date when the account was last updated. |
|
accountNumber
The unique account number assigned to the account. |
|
additionalEmailAddresses
A list of additional email addresses to receive emailed invoices. |
|
allowInvoiceEdit
If |
|
autoPay
If |
|
balance
The current outstanding balance for the account. |
|
batch
The batch group the account is a part of. |
|
bcdSettingOption
The billing cycle day setting option for the account. |
|
billCycleDay
The billing cycle day (BCD) on which bill runs generate invoices for the account. |
|
billToContactId
The ID of the person to bill for the account. Reference:
|
|
communicationProfileId
The ID of the communication profile associated with the account. Reference: |
|
createdById
The ID of the Zuora user who created the account. |
|
createdDate
The date when the account was created. |
|
creditBalance
The total credit balance for the account. |
|
crmId
The CRM account ID for the account. Used when Salesforce is integrated with your Zuora instance. |
|
currency
The currency that the customer is billed in. |
|
customerServiceRepName
The name of the account’s customer service representative, if applicable. |
|
defaultPaymentMethodId
The ID of the default payment method for the account. Reference: |
|
deleted
Only supported for the AQuA API. If |
|
invoiceDeliveryPrefsEmail
If |
|
invoiceDeliveryPrefsPrint
If |
|
invoiceTemplateId
The ID of the invoice template used for the account. |
|
lastInvoiceDate
The date when the previous invoice was generated for the account. This field will be |
|
name
The name of the account as displayed in the Zuora UI. |
|
notes
Any comments about the account. |
|
parentAccountId
The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora. Reference:
|
|
paymentGateway
The gateway used for processing electronic payments and refunds. |
|
paymentTerm
Indicates when the customer pays for subscriptions. |
|
purchaseOrderNumber
The number of the purchase order associated with this account. |
|
salesRepName
The name of the sales representative associated with the account, if applicable. |
|
soldToContactId
The ID of the person who bought the subscription associated with the account. Reference:
|
|
status
The status of the account in the system. Possible values are:
|
|
taxExemptCertificateId
The ID of the customer’s tax exemption certificate. |
|
taxExemptCertificateType
The type of tax exemption certificate that the customer holds. |
|
taxExemptDescription
The description of the tax exemption certificate that the customer holds. |
|
taxExemptEffectiveDate
The date when the customer’s tax exemption starts. |
|
taxExemptExpirationDate
The date when the customer’s tax exemption expires. |
|
taxExemptIssuingJurisdiction
The jurisdiction in which the customer’s tax exemption certificate was issued. |
|
taxExemptStatus
The status of the account’s tax exemption. Possible values are:
|
|
totalInvoiceBalance
The total balance of the account’s invoices. |
|
updatedById
The ID of the Zuora user who last updated the account. |
accountingCode
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
|
id
The accounting code ID. |
|
updatedDate
The date when the accounting code was last updated. |
|
category
The category associated with the accounting code. Possible values are:
|
|
createdById
The ID of the Zuora user who created the accounting code. |
|
createdDate
The date when the accounting code was created. |
|
deleted
Only supported for the AQuA API. If |
|
glAccountName
The name of the account in your general ledger. |
|
glAccountNumber
The account number in your general ledger. |
|
name
The name of the accounting code. |
|
notes
Additional notes about the accounting code. |
|
status
The status of the accounting code. Possible values are:
|
|
type
The accounting code type. Possible values are:
|
|
updatedById
The ID of the Zuora user who last updated the accounting code. |
accountingPeriod
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The accountingPeriod table contains information about the accounting periods in your Zuora account.
Note: To replicate this table, you must have Zuora Finance enabled.
|
id
The accounting period ID. Reference:
|
|
updatedDate
The date when the accounting period was last updated. |
|
createdById
The ID of the Zuora user who created the accounting period. |
|
createdDate
The date when the accounting period was created. |
|
endDate
The end date of the accounting period. |
|
fiscalQuarter
The fiscal quarter of the accounting period. |
|
fiscalYear
The fiscal year of the accounting period. |
|
name
The name of the accounting period. |
|
notes
Additional notes about the accounting period. |
|
runTrialBalanceEnd
The date that the trial balance was completed. |
|
runTrialBalanceErrorMessage
If the |
|
runTrialBalanceStart
The date that the trial balance was run. |
|
runTrialBalanceStatus
The status of the trial balance for the accounting period. Possible values are:
|
|
startDate
The start date of the accounting period. |
|
status
The status of the accounting period. Possible values are:
|
|
updatedById
The ID of the Zuora user who last updated the accounting period. |
amendment
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
|
id
The amendment ID. Reference:
|
|
updatedDate
The date when the amendment was last updated. |
|
autoRenew
If |
|
code
A unique string that identifies the amendment. |
|
contractEffectiveDate
The date when the amendment’s charges become effective for billing purposes. |
|
createdById
The ID of the Zuora user who created the amendment. |
|
createdDate
The date when the amendment was created. |
|
currentTerm
The length of the period for the current subscription term. This field is used with the |
|
currentTermPeriodType
The period type for the current subscription term. This field is used with the Possible values are:
|
|
customerAcceptanceDate
The date when the customer accepted the amendment’s changes to the subscription. |
|
deleted
Only supported for the AQuA API. If |
|
description
The description of the amendment. |
|
effectiveDate
The date when the amendment’s charges take effect. |
|
name
The name of the amendment. |
|
renewalSetting
Indicates whether a termed subscription will remain termed or change to evergreen when renewed. Possible values are:
|
|
renewalTerm
The term of the renewal for the amended subscription. This field is used with the `renewalTermPeriodType’ field to specify the subscription renewal term. |
|
renewalTermPeriodType
The period type for the subscription renewal term. This field is used with the `renewalTerm’ field to specify the subscription renewal term. Possible values are:
|
|
serviceActivationDate
The date when service is activated. |
|
specificUpdateDate
The date when the UpdateProduct amendment takes effect. Only applicable if there is already a future-dated UpdateProduct amendment on the subscription. |
|
status
The status of the amendment. Possible values are:
|
|
subscriptionId
The ID of the subscription that the amendment changes. Reference:
|
|
termStartDate
Indicates if the subscription is |
|
type
The type of amendment. Possible values are:
|
|
updatedById
The ID of the Zuora user who last updated the amendment. |
billingRun
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The billingRun table contains information about billing runs.
|
id
The ID of the billing run. |
|
updatedDate
The date when the billing run was last updated. |
|
autoEmail
Note: Only available if the Support Billing Run Auto-Post Billing Rule is enabled. If |
|
autoPost
Note: Only available if the Support Billing Run Auto-Post Billing Rule is enabled. If |
|
autoRenewal
Indicates if auto-renew subscriptions should be determined by the billing run. |
|
batch
The batch of accounts for the billing run. |
|
billCycleDay
The day of the billing cycle. |
|
billRunNumber
The billing run number. |
|
chargeTypeToExclude
The charge type(s) to be excluded from the billing run. |
|
createdById
The ID of the Zuora user who created the billing run. |
|
createdDate
The date when the billing run was created. |
|
deleted
Only supported for the AQuA API. If |
|
errorMessage
The error message for the billing run. |
|
executedDate
The execute date for the billing run. |
|
invoiceDate
The invoice date for the billing run. |
|
invoicesEmailed
If |
|
lastEmailSentTime
The last time emails were sent for the billing run. |
|
noEmailForZeroAmountInvoice
If |
|
numberOfAccounts
The number of accounts processed by the billing run. |
|
numberOfInvoices
The number of invoices generated by the billing run. |
|
status
The status for the billing run. Possible values are:
|
|
targetDate
The target date of the billing run. |
|
updatedById
The ID of the Zuora user who last updated the billing run. |
communicationProfile
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
|
id
The communication profile ID. Reference: |
|
updatedDate
The date when the communication profile was last updated. |
|
createdById
The ID of the Zuora user who created the communication profile. |
|
createdDate
The date when the communication profile was created. |
|
deleted
Only supported for the AQuA API. If |
|
description
The description of the communication profile. |
|
profileName
The name of the communication profile. |
|
updatedById
The ID of the Zuora user who last updated the communication profile. |
contact
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The contact table contains info about an account’s point-of-contact.
|
id
The contact ID. Reference:
|
|
updatedDate
The date when the contact was last updated. |
|
accountId
The ID of the account associated with the contact. Reference: |
|
address1
The first line of the contact’s address. |
|
address2
The second line of the contact’s address. |
|
city
The city of the contact’s address. |
|
country
The country of the contact’s address. |
|
createdById
The ID of the Zuora user who created the contact. |
|
createdDate
The date the contact was created. |
|
deleted
Only supported for the AQuA API. If |
|
description
The description of the contact. |
|
fax
The contact’s fax number. |
|
firstName
The first name of the contact. |
|
homePhone
The contact’s home phone number. |
|
lastName
The last name of the contact. |
|
mobilePhone
The contact’s mobile phone number. |
|
nickName
The nickname for the contact. |
|
otherPhone
The additional phone number for the contact. |
|
otherPhoneType
The type of the
|
|
personalEmail
The email address of the contact. |
|
postalCode
The zip code for the contact’s address. |
|
state
The state or province of the contact’s address. |
|
taxRegion
If using Zuora’s tax rules. |
|
updatedById
The ID of the Zuora user who last updated the contact. |
|
workEmail
The work email address of the contact. |
|
workPhone
The contact’s work phone number. |
contactSnapshot
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
|
id
The contact ID. Reference: |
|
updatedDate
The date when the contact was last updated. |
|
accountId
The ID of the account associated with the contact. Reference: |
|
address1
The first line of the contact’s address. |
|
address2
The second line of the contact’s address. |
|
city
The city of the contact’s address. |
|
contactId
The ID of the associated contact record. Reference:
|
|
country
The country of the contact’s address. |
|
createdById
The ID of the Zuora user who created the contact. |
|
createdDate
The date the contact was created. |
|
description
The description of the contact. |
|
fax
The contact’s fax number. |
|
firstName
The first name of the contact. |
|
homePhone
The contact’s home phone number. |
|
lastName
The last name of the contact. |
|
mobilePhone
The contact’s mobile phone number. |
|
nickName
The nickname for the contact. |
|
otherPhone
The additional phone number for the contact. |
|
otherPhoneType
The type of the
|
|
personalEmail
The email address of the contact. |
|
postalCode
The zip code for the contact’s address. |
|
state
The state or province of the contact’s address. |
|
taxRegion
If using Zuora’s tax rules. |
|
updatedById
The ID of the Zuora user who last updated the contact. |
|
workEmail
The work email address of the contact. |
|
workPhone
The contact’s work phone number. |
creditBalanceAdjustment
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The creditBalanceAdjustment table contains information about credit balance adjustments, or the application of credit balances to invoices, payments, and refunds.
|
id
The credit balance adjustment ID. |
|
updatedDate
The date when the credit balance adjustment was last updated. |
|
accountId
The ID of the account associated with the contact. Reference: |
|
accountingCode
The accounting code associated with the adjustment. |
|
accountingPeriodId
The ID of the accounting period associated with the adjustment. Reference:
|
|
accountReceivableAccountingCodeId
The ID of the account’s receivable accounting code associated with the adjustment. Reference: |
|
adjustmentDate
The date when the adjustment was applied. |
|
amount
The amount of the adjustment. |
|
billToContactId
The ID of the billing contact associated with the account to whom the product/service is billed. Reference:
|
|
cancelledOn
The date when the adjustment was canceled. |
|
cashOnAccountAccountingCodeId
The accounting code for customer cash on account. Reference: |
|
comment
Any comments about the adjustment. |
|
createdById
The ID of the Zuora user who created the credit balance adjustment. |
|
createdDate
The date when the credit balance adjustment was created. |
|
defaultPaymentMethodId
The default payment method the associated account uses to make payments. Reference: |
|
deleted
Only supported for the AQuA API. If |
|
invoiceId
The ID of the invoice to which the adjustment is applied. Reference: |
|
journalEntryId
The journal entry ID associated with the adjustment. Reference: |
|
journalRunId
The ID of the journal run associated with the adjustment. |
|
number
A unique identifier for the adjustment, generated by Zuora. |
|
parentAccountId
The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora. Reference:
|
|
paymentId
The ID of the payment associated with the adjustment. Reference: |
|
paymentMethodId
The ID of the payment method associated with the adjustment. Reference: |
|
paymentMethodSnapshotId
The ID of the payment method snapshot associated with the adjustment. Reference: |
|
reasonCode
The code identifying the reason for the adjustment. |
|
referenceId
The ID of the payment that the adjustment is for. |
|
refundId
The ID of the refund associated with the adjustment. Reference: |
|
soldToContactId
The ID of the person who bought the subscription associated with the account. Reference:
|
|
sourceTransactionId
The ID of the object that the adjustment was applied to. Depending on the type of transaction ( Reference: |
|
sourceTransactionNumber
The number of the object that the adjustment was applied to. Depending on the type of transaction ( Reference: |
|
sourceTransactionType
The source of the adjustment. Possible values are:
|
|
status
The status of the adjustment. Possible values are:
|
|
transferredToAccounting
The status of the adjustment being transferred to an external accounting system, such as NetSuite. Possible values are:
|
|
updatedById
The ID of the Zuora user who last updated the credit balance adjustment. |
discountAppliedMetrics
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The discountAppliedMetrics table contains information about rate plan charges that use either a discount-fixed amount or discount-percentage charge model.
export
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The export table contains information about export jobs and files.
|
id
The export ID. |
|
updatedDate
The date when the export was last updated. |
|
convertToCurrencies
The currencies that transaction amounts will be converted into. |
|
createdById
The ID of the Zuora user who created the export. |
|
createdDate
The date when the export was created. |
|
deleted
Only supported for the AQuA API. If |
|
encrypted
Indicates if encrypted data source fields (ex: |
|
fileId
The ID of the file generated by the export query. |
|
format
The format that the export file used. Possible values are:
|
|
name
The name of the export. |
|
query
Currently unsupported by the Zuora API. |
|
size
The number of records or rows exported. |
|
status
The status of the export. Possible values are:
|
|
statusReason
The reason for the given status. Useful for troubleshooting export failures. |
|
zip
If |
|
updatedById
The ID of the Zuora user who last updated the export. |
import
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The import table contains information about content uploads.
|
id
The import ID. |
|
updatedDate
The date when the import was last updated. |
|
createdById
The ID of the Zuora user who created the import. |
|
createdDate
The date when the import was created. |
|
deleted
Only supported for the AQuA API. If |
|
importType
The type of item imported. |
|
importedCount
The number of successfully imported records. |
|
md5
A check to validate the import file’s integrity. |
|
name
The name of the import. |
|
originalResourceUrl
The URL of the import file. |
|
resultResourceUrl
The URL for the import result file, which is a zipped CSV file. |
|
status
The status of the import. Possible values are:
|
|
statusReason
The reason for the given status. Useful for troubleshooting import failures. |
|
totalCount
The number of records in the import file. |
|
updatedById
The ID of the Zuora user who last updated the import. |
invoice
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The invoice table contains info about invoices, which are bills to customers.
|
id
The invoice ID. Reference: |
|
updatedDate
The date when the invoice was last updated. |
|
accountId
The account ID. Reference: |
|
adjustmentAccount
The amount of the invoice adjustments associated with the invoice. |
|
amount
The sum of all charges and taxes associated with the invoice. |
|
amountWithoutTax
The sum of all charges associated with the invoice, excluding taxes. |
|
autoPay
If |
|
balance
The remaining balance of the invoice after all payments, adjustments, and refunds are applied. |
|
billRunId
The ID of the bill run associated with the invoice. |
|
billToContactId
The ID of the person to bill for the invoice. Reference:
|
|
billToContactSnapshotId
The ID of the Bill To contact snapshot. Reference: |
|
comments
Additional info related to the invoice that a Zuora user added to the invoice. |
|
createdById
The user ID of the person who created the invoice. |
|
createdDate
The date when the invoice was generated. |
|
creditBalanceAdjustmentAmount
The currency amount of the adjustment applied to the customer’s credit balance. |
|
defaultPaymentMethodId
The ID of the default payment method for the account. Reference: |
|
deleted
Only supported for the AQuA API. If |
|
dueDate
The date by which the payment for the invoice is due. |
|
includesOneTime
If |
|
includesRecurring
If |
|
includesUsage
If |
|
invoiceDate
The date on which to generate the invoice. |
|
invoiceNumber
The unique identification number for the invoice. Reference: |
|
lastEmailSentDate
The date when the invoice was last emailed. |
|
parentAccountId
The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora. Reference:
|
|
paymentAmount
The amount of payments applied to the invoice. |
|
postedBy
The user ID of the person who moved the invoice to Posted status. |
|
postedDate
The date when the invoice was posted. |
|
refundAmount
The amount of a refund that was applied against an earlier payment on the invoice. |
|
soldToContactId
The ID of the person who bought the subscription associated with the account. Reference:
|
|
soldToContactSnapshotId
The ID of the Sold To contact snapshot. Reference: |
|
source
The source of the invoice. |
|
sourceId
The ID of the value in the |
|
status
The status of the invoice in the system. This is not the status of the invoice payment, but the invoice itself. Possible values are:
|
|
targetDate
The date used to determine which charged are to be billed. |
|
taxAmount
The total amount of the taxes applied to the invoice. |
|
taxExemptAmount
The total amount of the invoice that is tax exempt. |
|
transferredToAccounting
Indicates if the invoice was transferred to an external accounting system, such as NetSuite. Possible values are:
|
|
updatedById
The ID of the Zuora user who last updated the invoice. |
invoiceItem
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The invoiceItem table contains info about the line items in invoices.
|
id
The ID of the invoice item. Reference: |
|
updatedDate
The date when the invoice item was last updated. |
|
accountingCode
The accounting code for the items charged. |
|
appliedToChargeNumber
The charge number that the discount charge is applied to. This is only applicable to invoice items that are discount charges. |
|
appliedToInvoiceItemId
Associates a discount invoice item to a specific invoice item. |
|
chargeAmount
The amount being charged for the invoice item, without taxes. |
|
chargeDate
The date when the invoice item was created. |
|
chargeName
The name of the invoice item’s charge. |
|
createdById
The ID of the Zuora user who created the invoice item. |
|
createdDate
The date the invoice item was created. |
|
deleted
Only supported for the AQuA API. If |
|
invoiceId
The ID of the invoice associated with the invoice item. Reference: |
|
processingType
The processing type of the invoice item. Possible values are:
|
|
productDescription
The description of the product associated with the invoice item. |
|
productId
The ID of the product associated with the invoice item. Reference:
|
|
productRatePlanChargeId
The ID of the rate plan charge associated with the invoice item. Reference:
|
|
quantity
The number of units for the invoice item. |
|
ratePlanChargeId
The ID of the rage plan charge that’s associated with the invoice item. Reference:
|
|
revRecCode
Associates the invoice item with a specific revenue recognition code. |
|
revRecStartDate
The date when revenue recognition is triggered. |
|
revRecTriggerCondition
Specifies when revenue recognition begins based on a triggering event. |
|
serviceEndDate
The end date of the service period associated with the invoice item. Service will end one second before the date in this value. |
|
serviceStartDate
The start date of the service period associated with the invoice item. |
|
sku
The unique SKU for the product associated with the invoice item. |
|
subscriptionId
The ID of the subscription associated with the invoice item. Reference:
|
|
taxAmaount
The amount of tax applied to the invoice item’s charge. |
|
taxCode
The tax code for taxation rules. |
|
taxExemptAmount
The amount of the invoice item’s charge that is tax exempt. |
|
taxMode
The tax mode of the invoice item. |
|
unitPrice
The per-unit price of the invoice item. |
|
uom
The units to measure usage. |
|
updatedById
The ID of the Zuora user who last updated the invoice item. |
invoiceItemAdjustment
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The invoiceItemAdjustment table contains info about adjustments applied to invoice line items.
journalEntry
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The journalEntry table contains information about
|
id
The journal entry ID. |
|
updatedDate
The date when the journal entry was last updated. |
|
accountingPeriodId
The ID of the accounting period associated with the journal entry. |
|
createdById
The ID of the Zuora user who created the journal entry. |
|
createdDate
The date when the journal entry was created. |
|
currency
The currency the journal entry is in. |
|
deleted
Only supported for the AQuA API. If |
|
journalEntryDate
The date of the journal entry. |
|
journalRunId
The ID of the journal run associated with the journal entry. Reference: |
|
notes
Additional info about the journal entry. |
|
number
The number of the journal entry in the format |
|
status
The status of the journal entry. Possible values are:
|
|
transferDate
The date that the value of |
|
transferredBy
The ID of the Zuora user who changed the value of |
journalEntryItem
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The journalEntryItem table contains information about journal entry items.
|
id
The journal entry item ID. |
|
updatedDate
The date when the journal entry item was last updated. |
|
accountingCodeId
The accounting code associated with the journal entry item. |
|
accountingCodeType
The type of the accounting code associated with the journal entry item. Possible values are:
|
|
amount
The amount of the journal entry item in the transaction currency. |
|
createdById
The ID of the Zuora user who created the journal entry item. |
|
createdDate
The date when the journal entry item was created. |
|
deleted
Only supported for the AQuA API. If |
|
journalEntryId
The ID of the journal entry associated with the journal entry item. Reference: |
|
journalRunId
The ID of the journal run associated with the journal entry item. Reference: |
|
type
The type of journal entry item. |
|
updatedById
The ID of the Zuora user who last updated the journal entry item. |
journalRun
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The journalRun table contains information about journal runs.
|
id
The journal run ID. Reference: |
|
updatedDate
The date when the journal run was last updated. |
|
createdById
The ID of the Zuora user who created the journal run. |
|
createdDate
The date when the journal run was created. |
|
deleted
Only supported for the AQuA API. If |
|
executedOn
The date the journal run was executed. |
|
number
The number of the journal run. |
|
segmentationRuleName
The name of the GL segmentation rule used in the journal run. |
|
status
The status of the journal run. Possible values are:
|
|
targetEndDate
The target end date of the journal run. |
|
targetStartDate
The target start date of the journal run. |
|
totalJournalEntryCount
The total number of journal entries in the journal run. |
|
updatedById
The ID of the Zuora user who last updated the journal run. |
payment
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The payment table contains info about customer payments.
|
id
The payment ID. Reference: |
|
updatedDate
The date when the payment was last updated. |
|
accountId
The ID of the account associated with the payment. Reference: |
|
amount
The total amount of the payment. |
|
appliedAmount
The applied amount of the payment. |
|
authTransactionId
The authorization transaction ID from the payment gateway. |
|
bankIdentificationNumber
The first six digits of the credit or debit card used for the payment, when applicable. |
|
cancelledOn
The date when the payment was cancelled. |
|
comment
The comments about the payment. |
|
createdById
The ID of the Zuora user who created the payment. |
|
createdDate
The date the payment was created. |
|
creditBalanceAmount
The amount that the payment transfers to the credit balance. |
|
currency
The currency the payment was in. |
|
deleted
Only supported for the AQuA API. If |
|
effectiveDate
The date when the payment takes effect. |
|
gatewayId
The ID of the gateway instance that processes the payment. |
|
gatewayResponse
The message returned from the payment gateway for the payment. |
|
gatewayResponseCode
The code returned from the payment gateway for the payment. |
|
gatewayState
The status of the payment in the gateway. Possible values are:
|
|
markedForSubmissionOn
The date when a payment was marked and waiting for batch submission to the payment process. |
|
number
The unique identification number of the payment. |
|
paymentDate
The date when the payment takes effect. |
|
paymentId
The ID of the payment that is paymented. Reference: |
|
paymentMethodId
The unique ID of the payment method that the customer used to make the payment. Reference: |
|
paymentMethodSnapshotId
The unqiue ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction. |
|
paymentTransactionTime
The date when the payment was issued. |
|
referenceId
The transaction ID returned by the payment gateway for an electronic payment. |
|
refundAmount
The amount of the payment that is refunded, if applicable. |
|
secondPaymentReferenceId
The transaction ID returned by the payment gateway if there is an additional transaction for the payment. |
|
settledOn
The date when the payment was settled in the payment processor. This field is only applicable to Spectrum gateways. |
|
softDescriptor
A payment gateway-specific field that maps Zuora to other gateways. |
|
softDescriptorPhone
A payment gateway-specific field that maps Zuora to other gateways. |
|
status
The status of the payment. Possible values are:
|
|
submittedOn
The date when the payment was submitted. |
|
success
If |
|
type
The type of payment, either |
|
unappliedAmount
The unapplied amount of the payment. |
|
updatedById
The ID of the Zuora user who last updated the payment. |
paymentRun
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The paymentRun table contains information about payment runs.
|
id
The ID of the payment run. Reference: |
|
updatedDate
The date when the account was last updated. |
|
batch
The alias name given to a batch. |
|
billCycleDay
The day of the billing cycle, the day of the month when a bill run generates invoices for an account. |
|
billingRunId
The ID of the billing run associated with the payment run. Reference: |
|
completedOn
The date when the payment run completed. |
|
consolidatedPayment
If |
|
createdById
The ID of the Zuora user who created the payment run. |
|
createdDate
The date when the payment run was created. |
|
currency
The currency the payment run is in. |
|
deleted
Only supported for the AQuA API. If |
|
executedOn
The date the payment run is executed. |
|
number
The number of the payment run. |
|
numberOfErrors
The number of errors encountered by the payment run. |
|
numberOfInvoices
The number of invoices processed by the payment run. |
|
numberOfPayments
The number of payments processed by the payment run. |
|
status
The status for the payment run. Possible values are:
|
|
targetDate
The target date of the payment run. |
|
updatedById
The ID of the Zuora user who last updated the payment run. |
processedUsage
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The processedUsage table contains information about usage.
product
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The product table contains info about your company’s product offerings.
|
id
The product ID. Reference:
|
|
updatedDate
The date when the product was last updated. |
|
allowFeatureChanges
If |
|
category
The product’s category. Possible values are:
|
|
createdById
The ID of the Zuora user who created the product. |
|
createdDate
The date the product was created. |
|
deleted
Only supported for the AQuA API. If |
|
description
The description of the product. |
|
effectiveEndDate
The date when the product expires and can’t be subscribed to anymore. |
|
effectiveStartDate
The date when the product becomes available and can be subscribed to. |
|
name
The name of the product. |
|
sku
The unique SKU for the product. |
|
updatedById
The ID of the Zuora user who last updated the product. |
productRatePlan
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The productRatePlan table contains info about product rate plans, or the part of a product that customers can subscribe to.
|
id
The product rate plan ID. Reference:
|
|
updatedDate
The date when the product rate plan was last updated. |
|
createdById
The ID of the Zuora user who created the product rate plan. |
|
createdDate
The date the product rate plan was created. |
|
defaultPaymentMethodId
The ID of the default payment method associated with the account. Reference: |
|
deleted
Only supported for the AQuA API. If |
|
description
The description of the product rate plan. |
|
effectiveEndDate
The date when the product rate plan expires and can’t be subscribed to anymore. |
|
effectiveStartDate
The date when the product rate plan becomes available and can be subscribed to. |
|
name
The name of the product rate plan. |
|
productId
The ID of the product that contains the product rate plan. Reference:
|
|
updatedById
The ID of the Zuora user who last updated the product rate plan. |
productRatePlanCharge
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
|
id
The ID of the product rate plan charge. Reference:
|
|
updatedDate
The date when the product rate plan charge was last updated. |
|
accountingCode
The accounting code for the charge. |
|
applyDiscountTo
The type of charges to apply a specific discount to. Possible values are:
|
|
billCycleDay
The bill cycle day (BCD) for the charge, which determines which day of the month the customer is billed. For example: A value of |
|
billCycleType
Indicates how to determine the billing day for the charge. Possible values are:
|
|
billingPeriod
The billing period for the charge. The start day of the billing period is called the bill cycle day (BCD). Possible values are:
|
|
billingPeriodAlignment
Indicates how charges within the same subscription should be aligned if multiple charges begin on different dates. Possible values are:
|
|
billingTiming
The billing timing for the charge. Possible values are:
|
|
chargeModel
Determines how to calculate charges. Possible values are:
|
|
chargeType
The type of charge. Possible values are:
|
|
createdById
The ID of the Zuora user who created the product rate plan charge. |
|
createdDate
The date the product rate plan charge was created. |
|
defaultQuantity
The default quantity of units. |
|
deferredRevenueAccount
The name of the deferred revenue account for this charge. |
|
deleted
Only supported for the AQuA API. If |
|
description
The description of the charge. |
|
discountClass
The class that the discount belongs to. A discount class defines the order in which discount product rate plan charges are applied. |
|
discountLevel
Indicates what the discount applies to. Possible values are:
|
|
endDateCondition
Defines when the charge ends after the charge trigger date. Possible values are:
|
|
includedUnits
Indicates the number of units in the base set of units. |
|
listPriceBase
The list price base for the product rate plan charge. Possible values are:
|
|
maxQuantity
Indicates the maximum number of units for this charge. |
|
minQuantity
Indicates the minimum number of units for this charge. |
|
name
The name of the product rate plan charge. |
|
numberOfPeriod
Specifies the number of periods to use when calculating charges in an overage smoothing charge model. |
|
overCalculationOption
Determines when to calculate overage charges. Possible values are:
|
|
overageUnusedUnitsCreditOption
Determines whether the customer will credited with unused units of usage. Possible values are:
|
|
priceChangeOption
Indicates whether an automatic price change is applied when a termed subscription is renewed. Possible values are:
|
|
priceIncreaseOption
Indicates if an automatic price increase when a termed subscription is renewed. Possible values are:
|
|
productRatePlanId
The ID of the product rate plan associated with this product rate plan charge. Reference:
|
|
recognizedRevenueAccount
The name of the recognized revenue account for this charge. |
|
revRecCode
Associates the product rate plan charge with a specific revenue recognition code. |
|
revRecTriggerCondition
Indicates when revenue recognition begins. Possible values are:
|
|
revenueRecognitionRuleName
Indicates when the revenue for this charge is recognized. Possible values are:
|
|
smoothingModel
The smoothing model for an overage smoothing model. Possible values are:
|
|
specificBillingPeriod
The number of months or weeks for the charges billing period. |
|
taxCode
The tax code for taxation rules. |
|
taxMode
Defines taxation for the charge. Possible values are:
|
|
taxable
If |
|
triggerEvent
Indicates when the customer should begin to be billed. Possible values are:
|
|
uom
The units to measure usage. |
|
upToPeriods
The length of the period during which the charge is active. |
|
upToPeriodsType
The period type used to define when the charge ends. Possible values are:
|
|
updatedById
The ID of the Zuora user who last updated the product rate plan change. |
|
useDiscountSpecificAccountingCode
If |
|
useTenantDefaultForPriceChange
If true, the tenant-level percentage uplift value for an automatic price change to a termed subscription renewal will be applied. |
|
weeklyBillCycleDay
The day of the week that is used as the bill cycle day (BCD) for the charge. |
productRatePlanChargeTier
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The productRatePlanChargeTier table contains pricing info for product rate plan charges.
ratePlan
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
ratePlanChargeTier
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The ratePlanChargeTier table contains pricing info for rate plan charges.
refund
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The refund table contains info about refunds, or transactions where money is returned to a customer.
|
id
The refund ID. Reference: |
|
updatedDate
The date when the refund was last updated. |
|
accountId
The ID of the account associated with the refund. Reference: |
|
amount
The total amount of the refund. |
|
billToContactId
The ID of the billing contact for the associated account. Reference:
|
|
cancelledOn
The date when the refund was canceled. |
|
comment
The comments about the refund. |
|
createdById
The ID of the Zuora user who created the refund. |
|
createdDate
The date the refund was created. |
|
creditMemoId
The ID of the credit memo that is refunded. |
|
defaultPaymentMethodId
The ID of the default payment method for the associated account. Reference: |
|
deleted
Only supported for the AQuA API. If |
|
gatewayId
The ID of the gateway instance that processes the refund. |
|
gatewayResponse
The message returned from the payment gateway for the refund. |
|
gatewayResponseCode
The code returned from the payment gateway for the refund. |
|
gatewayState
The status of the refund in the gateway. Possible values are:
|
|
markedForSubmissionOn
The date when a refund was marked and waiting for batch submission to the payment process. |
|
methodType
The method used to issue an external refund to a customer. Possible values are:
|
|
number
The unique identification number of the refund. |
|
parentAccountId
The ID of the parent customer account for the associated account. This field is used when customer hierarchy is enabled in Zuora. Reference:
|
|
paymentId
The ID of the payment that is refunded. |
|
paymentMethodId
The unique ID of the payment method that the customer used to make the refund. Reference: |
|
paymentMethodSnapshotId
The unqiue ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction. |
|
reasonCode
The code identifying the reason for the transaction. |
|
referenceId
The transaction ID returned by the payment gateway for an electronic refund. |
|
refundDate
The date when the refund takes effect. |
|
refundTransactionTime
The date when the refund was issued. |
|
secondRefundReferenceId
The transaction ID returned by the payment gateway if there is an additional transaction for the refund. |
|
settledOn
The date when the refund was settled in the payment processor. This field is only applicable to Spectrum gateways. |
|
softDescriptor
A payment gateway-specific field that maps Zuora to other gateways. |
|
softDescriptorPhone
A payment gateway-specific field that maps Zuora to other gateways. |
|
soldToContactId
The ID of the person who bought the subscription associated with the account. Reference:
|
|
status
The status of the refund. Possible values are:
|
|
submittedOn
The date when the refund was submitted. |
|
success
If |
|
type
The type of refund, either |
|
updatedById
The ID of the Zuora user who last updated the refund. |
revenueChargeSummaryItem
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The revenueChargeSummaryItem table contains information about charge revenue summaries, which are summaries of all revenue distributions associated with a subscription charge.
revenueEventItem
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
revenueEventItemInvoiceItem
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The revenueEventItemInvoiceItem table contains information about revenue event items that are associated with invoice items.
revenueEventItemInvoiceItemAdjustment
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The revenueEventItemInvoiceItemAdjustment table contains information about revenue event items that are associated with invoice item adjustments.
revenueScheduleItem
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
revenueScheduleItemInvoiceItem
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The revenueScheduleItemInvoiceItem table contains information about revenue schedule item - invoice items.
revenueScheduleItemInvoiceItemAdjustment
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
The revenueScheduleItemInvoiceItemAdjustment table contains information about revenue schedule item - invoice items.
subscription
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updatedDate |
|
Primary Key :
|
id |
Official docs : |
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.
|
id
The subscription ID. Reference:
|
|
updatedDate
The date when the subscription was last updated. |
|
accountId
The ID of the account associated with this subscription. Reference: |
|
autoRenew
If |
|
cancelledDate
The date on which the subscription was canceled. |
|
contractAcceptanceDate
The date when the customer accepted the contract. |
|
contractEffectiveDate
The date when the contract takes effect. |
|
cpqBundleJsonId__qt
The bundle product structures from Zuora Quotes, if you utilize bundling in your Salesforce integration with Zuora. |
|
createdById
The ID of user who created the subscription. |
|
createdDate
The date the subscription was created. |
|
creatorAccountId
The account ID that created the subscription or the amended subscription. |
|
creatorInvoiceOwnerId
The account ID that owns the invoices associated with the subscription or the amended subscription. |
|
currentTerm
The length of the period for the current subscription term. |
|
currentTermPeriodType
The period type for the current subscription term. |
|
deleted
Only supported for the AQuA API. If |
|
initialTerm
The length of the period for the first subscription term. |
|
initialTermPeriodType
The period type for the first subscription term. Possible values are:
|
|
invoiceOwnerId
The account ID that owns the invoices associated with the subscription. |
|
isInvoiceSeparate
If |
|
name
The unqiue name of the subscription. |
|
notes
Any notes about the subscription. |
|
opportunityCloseDate__qt
The closing date of the Opportunity. |
|
opportunityName_qt
The unique name of the Opportunity. |
|
originalCreatedDate
The date when the subscription was originally created. |
|
originalId
The original ID of the subscription. |
|
previousSubscriptionId
The subscription ID immediately prior to the current subscription. |
|
quoteBusinessType__qt
The identifier for the type of business transaction the quote represents. For example: New, Renewal, Churn. |
|
quoteNumber__qt
The unique identifier of the Quote. |
|
quoteType__at
The Quote type that represents the subscription lifecycle stage. For example: Amendement, Renew. |
|
renewalSetting
Indicates whether a termed subscription will remain termed or change to evergreen when it is renewed. Possible values are:
|
|
renewalTerm
The length of the period for the subscription renewal term. |
|
renewalTermPeriodType
The period type for the subscription renewal term. Possible values are:
|
|
serviceActivationDate
The date when the subscription is activated. |
|
status
The status of the subscription. Possible values are:
|
|
subscriptionEndDate
The date when the subscription term ends, where the subscription ends at midnight the day before. For example: If this date is |
|
subscriptionStartDate
The date when the subscription term starts. |
|
termEndDate
The date when the subscription term ends. |
|
termStartDate
The date when the subscription term begins. |
|
termType
Indicates if a subscription is termed or evergreen. |
|
updatedById
The ID of the Zuora user who last updated the subscription. |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.