Subscription - Data dictionary
This article lists all the fields associated with the Subscription data dictionary in Zuora. Read more on Subscription here.
Note: Fields with an asterisk mark indicate mandatory fields.
| Name | Description | Value |
| IsNewSubscription | Marker Column | TRUE |
| Account Id* | customer account number or ID | Account Number or ID |
| Contract Effective Date* | Effective contract date for this subscription, as yyyy-mm-dd |
String- date |
| Renewal Term* | The length of the period for the subscription renewal term. Default is 0. | integer <int64> |
| Term Type* | Possible values are: TERMED, EVERGREEN. | String |
| Target Date | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. | String- date |
| Application Priority Order | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: CreditMemo, UnappliedPayment. | Array of strings |
| Apply Credit | Note: This field is only available if you have Invoice Settlement enabled.If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices | Boolean |
| Apply Credit Balance | If you are using the field invoiceCollect rather than the field invoice, the invoiceCollect value must be true. This field is deprecated if you have the Invoice Settlement feature enabled. |
Boolean |
| Auto Renew | This field is only required if the termType field is set to TERMED. | Boolean |
| Collect | Default: true Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. |
Boolean |
| CpqBundle JsonId QT | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. | string <= 32 characters |
| Credit Memo Reason Code | The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. | String |
| Customer Acceptance Date | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. | String-date |
| Document Date | The date of the billing document, in yyyy-mm-dd format. | String-date |
| Externally Managed By | Enum: "Amazon" "Apple" "Google" "Roku" | String |
| Gateway Id | The ID of the payment gateway instance. For example, 2c92c0f86078c4d5016091674bcc3e92. | String |
| Initial Term | The length of the period for the first subscription term. If termType is TERMED, then this field is required, and the value must be greater than 0. If termType is EVERGREEN, this field is ignored. | integer <int64> |
| Initial Term Period Type | Values are: Month (default), Year, Day, Week | String |
| Integration Id NS | ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. | string <= 255 characters |
| Integration Status NS | Status of the subscription's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. | string <= 255 characters |
| Invoice Owner Account Key | Invoice owner account number or ID. | String |
| Invoice Separately | Separates a single subscription from other subscriptions and invoices the charge independently.If the value is true, the subscription is billed separately from other subscriptions. If the value is false, the subscription is included with other subscriptions in the account invoice. The default value is false. Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes. |
Boolean |
| Last Booking Date | The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value today is set per the user's timezone. | String-date |
| Notes | String of up to 500 characters | String <=500 |
| Opportunity Close Date QT | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | String-date |
| Opportunity Name QT | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | String<=100 |
| Payment MethodID | The ID of the payment method used for the payment. | String |
| Prepayment | Indicates whether the subscription will consume the reserved payment amount of the customer account. See Prepaid Cash with Drawdown for more information. | Boolean |
| Project NS | The NetSuite project that the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite. | String <= 255 characters |
| Quote Business Type QT | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. | String <= 32 characters |
| Quote Number QT | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. | String <= 32 characters |
| Quote Type QT | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. | String <= 32 characters |
| Renewal Setting | Values: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN. It is captured from the tenant level configurations in Settings >Billing>SubscriptionandOrder Settings | String |
| Renewal Term Period Type | The period type for the subscription renewal term. Values are:Month (default),Year,Day,Week | String |
| Run Billing | Default- True, Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the invoice and credit memo generation rule. It is captured from the Tenant Level Confugurations in Settings>Billing>Billing Rules>Bill Run | Boolean |
| Sales Order NS | The NetSuite sales order than the subscription was created from. | String <=255 characters |
| Service Activation Date | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd. | String- date |
| Subscription Number | The value can be 1000 characters | String |
| Sync Date NS | Date when the subscription was synchronized with NetSuite. | String <=255 characters |
| Term Start Date | The date on which the subscription term begins, as yyyy-mm-dd. | String-date |
| IsNewRatePlan | Marker Column | TRUE/ FALSE |
| Rate Plan External Catalog Plan Id | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. | String |
| Rate Plan External Id Source System | The ID of the external source system. You can use this field and externalCatalogPlanId to specify a product rate plan that is imported from an external system. | String |
| Rate Plan Externally Managed Plan Id | Indicates the unique identifier for the rate plan purchased on a third-party store. | String |
| Rate Plan Product Rate Plan Id | ID of a product rate plan for this subscription. | String |
| Rate Plan Product Rate Plan Number | Number of a product rate plan for this subscription. | String |
| IsNewRatePlanRatePlanCharge | Marker Column | TRUE/ FALSE |
| Rate Plan Charge Override Product Rate Plan Charge Id* | ID of a product rate-plan charge for this subscription | String |
| Rate Plan Charge Override Amended By Order On | The date when the rate plan charge is amended through an order or amendment. | String |
| Rate Plan Charge Override Apply Discount To | Specifies the type of charges that you want a specific discount to apply to. Values: Onetime, Recurring, Usage, Onetimerecurring,Onetimeusage,RecurringUsage,Onetimerecurringusage | String |
| Rate Plan Charge Override Bill Cycle Day | Values 1- 30 | String |
| Rate Plan Charge Override Bill Cycle Type | Specifies how to determine the billing day for the charge. When this field is set to SpecificDayofMonth, set the BillCycleDay field. When this field is set to SpecificDayofWeek, set the weeklyBillCycleDay field. Values:DefaultFromCustomer,SpecificDayofMonth,SubscriptionStartDay,ChargeTriggerDay,SpecificDayofWeek It is captured from the tenant level configurations in Settings>Billing>Customise Billing Day |
String |
| Rate Plan Charge Override Billing Period | Billing period of the charge. It is captured from the tenant level configurations in Settings>Billing> Customise Billing Periods | String |
| Rate Plan Charge Override Billing Period Alignment | Aligns charges within the same subscription if multiple charges begin on different dates. Values: AlignToCharge, AlignToSubscriptionStart,AlignToTermStart | String |
| Rate Plan Charge Override Billing Timing | Values: IN_Advance (default), In_Arreas | String |
| Rate Plan Charge Override Charge Number | Max 50 characters. System-generated if not provided. | String |
| Rate Plan Charge Override Description | Description of the charge | String |
| Rate Plan Charge Override Discount Amount | Specifies the amount of fixed-amount discount. | Number |
| Rate Plan Charge Override Discount Level | Values: Rateplan,Subscription,Account | String |
| Rate Plan Charge Override Discount Percentage | Percentage of discount for a percentage discount. | Number |
| Rate Plan Charge Override End Date Condition | Defines when the charge ends after the charge trigger date. Values:Subscription_End, Fixed_Period, Specific_End_Date, One_Time | String |
| Rate Plan Charge Override Exclude Item Billing From Revenue Accounting | This field is only available if you have the Billing - Revenue Integration feature enabled. | Boolean |
| Rate Plan Charge Override Exclude Item Booking From Revenue Accounting | Default- false. This field is only available if you have the Billing - Revenue Integration feature enabled. | Boolean |
| Rate Plan Charge Override Included Units | Must be >=0 | Number |
| Rate Plan Charge Override Is Allocation Eligible | This field is used to identify if the charge segment is allocation eligible in revenue recognition | Number |
| Rate Plan Charge Override Is Unbilled | This field is used to dictate how to perform the accounting during revenue recognition. | Boolean |
| Rate Plan Charge Override List Price Base | It is captured from the tenant level configurations in Settings>Billing>Customise Billing Day | String |
| Rate Plan Charge Override Number Of Periods | Specifies the number of periods to use when calculating charges in an overage smoothing charge model | Integer <int64> |
| Rate Plan Charge Override Original Order Date | The date when the rate plan charge is created through an order or amendment. This field is not updatable | String-date |
| Rate Plan Charge Override Overage Price | Price for units over the allowed amount | Number |
| Rate Plan Charge Override Overage Unused Units Credit Option | Values: NoCredit, CreditBySpecificRate | String |
| Rate Plan Charge Override Price | Price for units in the subscription rate plan. | Number |
| Rate Plan Charge Override Price Change Option | Values: NoChange (default), SpecificPercentageValue,UselatestProductCatalogPricing | String |
| Rate Plan Charge Override Price Increase Percentage | Required if you set the PriceChangeOption field to SpecificPercentageValue.Value must be a decimal between -100 and 100. | Number |
| Rate Plan Charge Override Product Rate Plan Charge Number | Number of a product rate-plan charge for this subscription | String |
| Rate Plan Charge Override Quantity | Number of units. Must be a decimal >=0 | Number |
| Rate Plan Charge Override Rating Group | Specifies a rating group based on which usage records are rated. | String |
| Rate Plan Charge Override Specific Billing Period | Required if you set the value of the billingPeriod field to Specific_Months or Specific_Weeks. | Integer <int64> |
| Rate Plan Charge Override Specific End Date | This field is only applicable when the endDateCondition field is set to Specific_End_Date. | String-date |
| Rate Plan Charge Override Specific List Price Base | [ 1 .. 200 ]The number of months for the list price base of the charge. This field is required if you set the value of the listPriceBase field to Per_Specific_Months | Integer <int32> |
| Rate Plan Charge Override Trigger Date | Required if the triggerEvent field is set to USD. | String-date |
| Rate Plan Charge Override Trigger Event | Specifies when to start billing the customer for the charge.Values:UCE,USA,UCA,USD | Sring |
| Rate Plan Charge Override Unused Unit Credit Rates | This field applies only for overage charge models when the OverageUnusedUnitsCreditOption field is set to CreditBySpecificRate | Number |
| Rate Plan Charge Override Up To Period Type | Note: You must use this field together with the upToPeriodsType field to specify the time period.This field is applicable only when the endDateCondition field is set to Fixed_Period. If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. |
Integer <int64> |
| Rate Plan Charge Override Up To Periods | The period type used to define when the charge ends. This field is applicable only when the endDateCondition field is set to Fixed_Period | String |
| Rate Plan Charge Override Weekly Bill Cycle Day | It is captured from tenant level configurations in Settings>Billing>Customise Billing Day | String |
| Rate Plan Charge Override Model Configuration Custom Field Per Unit Rate | The custom field that carries the per-unit rate for each usage record. For example, perUnitAmount__c. This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model |
String |
| Rate Plan Charge Override Model Configuration Custom Field Total Amount | The custom field that carries the total amount to charge for a usage record. For example, totalAmount__c. This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. |
String |
| Rate Plan Charge Override Model Configuration Formula | The pricing formula to calculate actual rating amount for each usage record. This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. |
String |
| IsNewRatePlanRatePlanChargeRatePlanChargeTier | Marker Column | TRUE/ FALSE |
| Rate Plan Charge Override Tier Number* | Unique number that identifies the tier that the price applies to. | Integer <int64> |
| Rate Plan Charge Override Tier Price* | Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing | Number |
| Rate Plan Charge Override Tier Ending Unit | Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing. | Number |
| Rate Plan Charge Override Tier Price Format | Indicates if pricing is a flat fee or is per unit.Values: FlatFee,PerUnit | Number |
| Rate Plan Charge Override Tier Starting Unit | Starting number of a range of units for the tier. | Number |