Rate Plan Data Source

Last updated
Save as PDF

Overview

Use this data source to export summary data on rate plans that appear on subscriptions, including associated data on account, subscription, and product information from the product catalog.

Objects Available in the Data Source

Object	Description
Account	The account number.
Amendment	The amendment that is tied to the rate plan, if applicable.
Bill To Contact	The contact of the entity/person to whom you bill for your product or service.
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
Sold To Contact	The contact of the entity/person to whom your product or service is sold.
Default Payment Method	The default payment method used to make payments.
Product	The product information. Contains the following fields: AllowFeatureChanges Category Created By ID Created Date Description Effective End Date Effective Start Date ID Name NetSuite Integration ID NetSuite Integration Status NetSuite Item Type NetSuite Sync Date SKU Updated By ID Updated Date
Product Rate Plan	The rate plan coming from the product catalog. Contains the following fields: Created By ID Created Date Description Effective End Date Effective Start Date ExternalldSourceSystem Grade ID Name Updated By ID Updated Date
Rate Plan	Refers to the rate plan or pricing plan information associated with the subscription. Contains the following fields: Amendment Type: Note that a filter on this field using the unequal operator cannot return those Rate Plan records with a blank Amendment Type field. Created By ID Created Date Externally Managed Plan ID: a text field. This field indicates the unique identifier of a rate plan purchased on a third-party store. ID Invoice Owner ID: the invoice owner ID of the subscription that contains the rate plan Name Original Rate Plan ID: the original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription Subscription Owner ID: the subscription owner ID of the subscription that contains the rate plan Subscription Rate Plan Number Updated By ID Updated Date The Amendment Type and Original Rate Plan ID fields are not available for single version subscriptions.
Subscription	The subscription the rate plan belongs to.
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. See below for more information.

Subscription Version Amendment

The RatePlan.Amendment Type and Amendment.Type fields show the type of the most recent amendment that touched a particular RatePlan. While there is no change to the meaning of these fields from before, note that the fields do not reflect Renewals, Cancellations, and Terms & Conditions Amendments. For example, if a subscription has been renewed, the RatePlan.Amendment Type field will continue to carry the Amendment Type value from before the renewal.

The SubscriptionVersionAmendment.Type field shows the type of the Amendment that most recently touched a particular Subscription version. This field will include all Amendment types, including Renewals, Cancellations, and Terms & Conditions.

Because the SubscriptionVersionAmendment.Type field is on a per-Subscription Version basis, it will have the same value for all RatePlans contained in a particular Subscription Version. This can result in some ambiguity. For example, if one of the RatePlans (on a subscription that has two RatePlans) is updated, the SubscriptionVersionAmendment.Type will show a value of UpdateProduct for both RatePlans. This can be disambiguated by comparing the values of SubscriptionVersionAmendment.Type and RatePlan.Amendment Type. A match indicates that the Amendment affected that particular RatePlan and a mis-match indicates that the RatePlan was not affected.

Using the Export ZOQL to export subscription data

You can use the SubscriptionVersionAmendment object to export the Renewal or Terms and Conditions amendments from the Rate Plan data source object, in addition to the other amendment types that are already available. For example, you can use the following Export ZOQL query:

select SubscriptionVersionAmendment.id, SubscriptionVersionAmendment.type from RatePlan  [where Account.Name = 'ACCOUNT_NAME']