You are here:
Subscriptions Object Fields for Legacy Data Upload
Create your Salesforce CPQ legacy data import file by defining and populating the fields required for the subscriptions object. (Salesforce CPQ Managed Package)
Required Editions
| Available in: All Salesforce CPQ and Salesforce Billing Editions |
Fields to Populate on the Subscriptions Object
| Field API Name | Type | Description |
|---|---|---|
| SBQQ__Account__c | Lookup(Account) | Lookup to the subscription's parent account. This relationship is used for volume discount calculations. |
| SBQQ__Contract__c | Lookup(Contract) | Lookup to the parent contract record. The contract that governs this subscription. |
| SBQQ__RootId__c | Text (18) | The 18-digit SF ID of a bundle parent's asset or subscription record. For bundles, the Root ID field on Subscriptions (SBQQ__RootID__c) must be populated with the 18-digit SF ID of the bundle parent's subscription or asset record. If RootID isn’t populated, the bundle structure is lost or renewals and amendments fail during creation. |
| SBQQ__Product__c | Lookup(Product) | Lookup to the related product record. |
| SBQQ__Number__c | Number(5,0) | The field dictates the order the product is listed within its group or quote in the quote line editor. Any number can be used, but must be unique within the group or quote. Required if SBQQ__QuoteLine__c lookup isn’t populated. |
| SBQQ__Quantity__c | Number(10,2) | The quantity of the subscription. |
| SBQQ__RenewalQuantity__c | Number(10,2) | The quantity of the subscription upon renewal, usually the same as SBQQ__Quantity__c. |
| SBQQ__PricingMethod__c | Picklist | The pricing method selected indicates how the price for the line item is calculated. List equals subtracting discount from list price. Cost equals adding markup to cost. |
| SBQQ__ListPrice__c | Currency(12,2) | Pricebook entry's unit price of the product sold. |
| SBQQ__CustomerPrice__c | Currency(12,2) | Unit price including any systematic and discretionary discounts. |
| SBQQ__NetPrice__c | Currency(12,2) | Unit price including any partner and distributor discounts. |
| SBQQ__ProrateMultiplier__c | Number(8,4) | Calculated ratio used to compute the prorated price. Contract term divisible by the product’s default subscription term. The calculation depends on your Subscription Proration Settings. |
| SBQQ__RenewalPrice__c | Currency(12,2) | The non-prorated net unit price. This field is optional. Define the price of quote lines that appear on the renewal quote when you renew this subscription. This field overrides the result of price calculations from your account’s renewal pricing method. If your account uses Uplift renewal pricing, the uplift is applied directly to the Renewal Price field. |
| SBQQ__DiscountScheduleType__c | Picklist | The type of schedule that determines how a discount is calculated. Choices are Range or Slab. Required if the product has a discount schedule defined. The type must match the type from the discount schedule defined in the lookup. |
| SBQQ__DiscountSchedule__c | Lookup(Discount Schedule) | Required if the product has a discount schedule defined or is otherwise defined in a bundle, for example, a product option. Specifies discounts in terms of percent or amount are discounted off the product's price by using quantity purchased or term. Set quantity/term ranges in tiers of different discount percentages. The discount applies to the list price and the resulting total is stored in the regular price. |
| SBQQ__TermDiscountSchedule__c | Lookup(Discount Schedule) | Required if the product has a term discount schedule defined. The discount schedule for discounts is based on subscription terms. Used to show a breakdown of payments into separate groups for different terms with the discount reflected for the duration of the subscription. Leave Term Discount Level blank if you want discount schedules applied based on the term of each line item. |
| SBQQ__SubscriptionPricing__c | Picklist | The method for calculating the subscription price. Subscription products have two pricing types, controlled by the Subscription Pricing field. Fixed Price: The product gets its list price from a price book entry. Percent of Total: The product’s list price is a percentage of the quote, quote line group, or a bundle’s total price. |
| SBQQ__ProductSubscriptionType__c | Picklist | Set the value to the subscription type. This field is the value set on a product indicating whether the subscription type of the line is One-time, Renewable, or Evergreen. |
| SBQQ__SubscriptionType__c | Picklist | Same as ProductSubscriptionType, or a different value from product configuration. Indicates whether the subscription type of the line is One-time, Renewable, or Evergreen. |
| SBQQ__SubscriptionStartDate__c | Date | The start date of the subscription. This field is populated only when the quote line’s start date and the contract’s start date are the same. When the quote line’s start date and the contract’s start date are different, this field is blank. |
| SBQQ__SubscriptionEndDate__c | Date | The end date of the subscription. On the Subscription record, this field is populated with the quote line’s end date if it doesn’t match the contract. If the date matches the contract, this field is blank and looks up the contract for this date information. Leave this field blank for evergreen products. |
Important Amendments pull in the current list price. To retain an existing discount
on an amendment quote, the additional discount percent off amount is taken from the subscription
and applied. Expect the product price on the amendment quote to reflect the current list price,
less the existing discounts from the subscription, when it’s included with your data
load.
| Field API Name | Type | Description |
|---|---|---|
| SBQQ__Bundle__c | Checkbox | Required if the product is a parent to other products. Indicates that the product on the line item is bundled with another product in the quote or order. |
| Field API Name | Type | Description |
|---|---|---|
| SBQQ__OptionLevel__c | Number(5,0) | Indicates the nest level of this option: 1 for children of the parent product and 2 for grandchildren of the top-level bundle product. Applies only to lines generated from options. |
| SBQQ__BundledQuantity__c | Number(10,2) | The initial quantity of the option before it was multiplied by the parent's quantity. For items with calculated quantities, this field holds the original (user-entered) quantity. |
| SBQQ__ProductOption__c | Lookup(Product Option) | Lookup to the product option that joins the parent product reference to this subscription's product. |
| SBQQ__OptionType__c | Picklist | Indicates the option type from the related product options and determines how the quantity is calculated. Types are Component, Accessory, or Related Product. Option type must match the type of the referenced product option record. |
| SBQQ__RequiredByProduct__c | Lookup(Product) | The bundle parent’s product record for the referenced product option. |
| SBQQ__ComponentSubscriptionScope__c | Picklist | This field overrides the subscription scope copied from the product and is set at the component level. Values are Package, Components, Package and Components, or Entire Hierarchy. If the child subscription is a percent of total priced product, this field must be populated to limit the percent of total scope to the bundle containing the product. |
| SBQQ__RequiredById__c | Text(18) | ID to the related parent product record in a bundle on the contract level (Subscription/Asset Id). Required for amendments. |
| SBQQ__DynamicOptionId__c | Text(18) | The Dynamic Option ID field contains a combination of the Feature ID and Product ID to identify the feature and product associated with the Dynamic Bundle. Required for dynamic bundles. |
| Field API Name | Type | Description |
|---|---|---|
| SBQQ__SubscriptionPricing__c | Picklist | Set the value to Percent of Total. This field is used for price calculation based on the value selected. |
| SBQQ__ProductSubscriptionType__c | Picklist | Set the value to Renewable, if the product is a renewable product. This field is the value set on a product that is copied over, indicating if the subscription type of the line is One-time, Renewable, or Evergreen. |
| SBQQ__SubscriptionType__c | Picklist | Same as ProductSubscriptionType, or a different value from product configuration. Indicates whether the subscription type of the line is One-time, Renewable, or Evergreen. |
Note Subscribed assets must be created if Percent of Total is included in your data load.
| Field API Name | Type | Description |
|---|---|---|
| SBQQ__SegmentStartDate__c | Date | For multi-segmented products, the start date from the original segment's quote line. |
| SBQQ__SegmentEndDate__c | Date | For multi-segmented products, the end date from the original segment's associated quote line. |
| SBQQ__Dimension__c | Lookup | The 18-digit SF ID of the price dimension associated with this subscription. |
| SBQQ__SegmentIndex__c | Number | For multi-segmented products, the number represents the related quote line’s position in the segment table. |
| SBQQ__SegmentKey__c | Text | For multi-segmented products, a shared key is used to group multi-dimensional quote line items. Unique random number or characters for the MDQ product. |
| SBQQ__SegmentLabel__c | Text | Defines the column header label associated with the quote line, based on the type of price dimension. Value equals Type plus SegmentIndex. Select the value as follows for Month and the first segment - Month 1, then Month 2, and so on. For Quarter - Quarter 1, Quarter 2, and so on. For Year - Year 1, Year 2, and so on. |
| SBQQ__SegmentUplift__c | Percent | The uplift percentage from the original segment's line. This field is optional. Add lift percent or set to zero. |
| SBQQ__SegmentUpliftAmount__c | Currency | The uplift amount from the original segment's line. This field is optional. Add lift amount or set to zero. |
| SBQQ__SegmentQuantity__c | Number | For MDQ products, the quantity corresponds to the segment's original quote line quantity. |
| Field API Name | Type | Description |
|---|---|---|
| SBQQ__ProductSubscriptionType__c | Picklist | Set the value to Evergreen. This field is the value set on a product that is copied over, indicating if the subscription type of the line is One-time, Renewable, or Evergreen. |
| SBQQ__SubscriptionType__c | Picklist | Set the value to Evergreen. Indicates whether the subscription type of the line is One-time, Renewable, or Evergreen. |
Did this article solve your issue?
Let us know so we can improve!
