Skip to main content

Subscription Data Source

Zuora

Subscription Data Source

  1. Last updated
  2. Save as PDF

Use this data source to export summary data about subscriptions and associated accounts, including Start and End Dates, Term, Status and Renewal data.

Objects Available in the Data Source

Base Object Description

Descriptions for the base Zuora objects.

Zuora Object Description
Subscription

Contains the following fields:

  • Auto Renew
  • Cancel Reason - The reason for a subscription cancellation copied from the changeReason field of a Cancel Subscription order action. This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be null.
  • Cancelled Date
  • Contract Acceptance Date
  • Contract Effective Date
  • Cpq Bundle Json ID
  • Created By ID
  • Created Date
  • Creator Account ID： This field is not available for single version subscriptions.
  • Creator Invoice Owner ID： This field is not available for single version subscriptions.
  • Currency
  • Current Term
  • Current Term Period Type

The following fields whose names starting with “External” are only available for omnichannel subscriptions:

  • External Activation Date
  • External Application Id
  • External Bundle Id
  • External Expiration Date
  • External In App Ownership Type
  • External Last Renewal Date
  • External Next Renewal Date
  • External Price
  • External Product Id
  • External Purchase Date
  • External Purchase Type
  • External Quantity
  • External Replace By ProductId
  • External Source System
  • External State
  • External Subscriber Id
  • External Subscription Id
  • External Transaction Reason
  • Externally Managed By
  • ID
  • Initial Term
  • Initial Term Period Type
  • Invoice Group Number
  • Invoice Owner ID
  • Invoice Separate
  • Invoice Template ID
  • Is Latest Version - Indicates whether the current subscription object is the latest version. This field is not available for single version subscriptions.
  • Last Booking Date - The last change date of a subscription. The value of this field is as follows:
    • For a new subscription created by the Subscribe and Amend APIs and UI, this field has the value of the subscription creation date.
    • For a subscription changed by an amendment, this field has the value of the amendment booking date.
    • For a subscription created or changed by an order, this field has the value of the order date.
  • Name
  • Notes
  • Opportunity Close Date
  • Opportunity Name
  • Original Created Date
  • Original ID： This field is not available for single version subscriptions.
  • Original Purchase Date: This field is only available for omnichannel subscriptions.
  • Payment Term
  • Previous Subscription ID：This field is not available for single version subscriptions.
  • Quote Business Type
  • Quote Number
  • Quote Type
  • Ramp ID - Indicates the ramp that is related to this subscription. Note that this field is only available if you have enabled the Ramps feature.
  • Renewal Setting
  • Renewal Term
  • Renewal Term Period Type
  • Revision
  • Sequence Set ID
  • Service Activation Date
  • State: This field is only available for omnichannel subscriptions.
  • Status
  • Subscription End Date
  • Subscription Start Date
  • Term End Date
  • Term Start Date
  • Term Type
  • Updated by ID
  • Updated Date
  • Version

 

Related Object Descriptions

Object Description
Account The customer account to which the subscription belongs.
Bill To Contact The bill to contact of the account to whom the subscription belongs.
Bill To Contact Snapshot The snapshot of the bill to contact which stores the historical bill to contact.
Default Payment Method The default payment method information for the subscription.
Entity

The entity that the data relates to. Part of the Multi-entity feature. Contains the following fields:

  • Address 1
  • Address 2
  • City
  • Country
  • Created By ID
  • Created Date
  • Display Name
  • Email
  • ID
  • Name
  • Postal Code
  • State
  • Updated By ID
  • Updated Date
Invoice Owner
  • Account Balance
  • Account Number
  • Additional Email Addresses
  • Allow Invoice Editing
  • Auto Pay
  • Bill Cycle Day
  • Bill Cycle Day Setting Option
  • Billing Batch
  • CMRR
  • CRM Account ID
  • CSR
  • CommunicationProfile ID (In the case that this field has no value, the system will use the default Communication Profile to send out notifications.)
  • Created By ID
  • Created Date
  • Credit Balance
  • Currency
  • Default Payment Method ID
  • Fee
  • ID
  • Invoice Delivery Preferences Email
  • Invoice Delivery Preferences Print
  • Invoice Template ID
  • Last Invoice Date
  • Last Metrics Update (available only if you have the Reseller Account feature enabled)
  • Name
  • Notes
  • PO Number
  • Parent ID
  • Partner Account (available only if you have the Reseller Account feature enabled)
  • Payment Gateway Name
  • Payment Method Cascading Consent
  • Payment Term
  • Reserved Payment Amount
  • Roll Up Usage to Parent Account
  • Sales Rep
  • Sequence Set ID
  • Status
  • Tax Company Code
  • Tax Exempt Certificate ID
  • Tax Exempt Certificate Type
  • Tax Exempt Description
  • Tax Exempt Effective Date
  • Tax Exempt Entity/Use Code
  • Tax Exempt Expiration Date
  • Tax Exempt Issuing Jurisdiction
  • Tax Exempt Status
  • Total Debit Memo Balance (This field is only used for Credit and Debit Memo.)
  • Total Invoice Balance
  • Unapplied Balance (The value of this field is the unapplied payment amount.)
  • Unapplied Credit Memo Amount (This field is only used for Credit and Debit Memo.)
  • Updated By ID
  • Updated Date
  • VAT ID
Parent Account The parent account of the Account.
Sold To Contact The sold to contact of the account to whom the subscription belongs.
Subscription Status History

 The status history information of a subscription. Contains the following fields:

  • Created By ID - The ID of the user who creates the subscription.
  • Created Date - The date when the subscription is created.
  • End Date - The latest date that the status ends.
  • ID - The unique identifier of the subscription.
  • Sort Order - The chronological order of the subscription statuses.
  • Start Date - The effective start date of the status history.
  • Status - The status of the subscription.
  • Subscription Number - The subscription number that uniquely identifies each subscription.
  • Updated By ID - The ID of the user who last updates the subscription.
  • Updated Date - The date when the subscription is last updated.
Subscription Version Amendment The amendment that generated a particular version of a subscription.