You are here:
CPQ Subscription Fields
Subscription records contain information about subscription products on opportunities or orders that you’ve contracted. When you contract an opportunity or order, your subscriptions inherit their field values from their subscription product quote line items or order products. (Salesforce CPQ Managed Package)
Required Editions
| Available in: All Salesforce CPQ Editions |
| Field | API Name | Data Type | Definition |
|---|---|---|---|
| Account | SBQQ__Account__c | Lookup (Account) | Account that owns the subscription. This relationship is used for volume discount calculations. |
| Additional Discount (%) | SBQQ__Discount__c | Percent (9, 2) | Additional customer discount for this subscription expressed as a percentage. |
| Additional Discount (Amount) | SBQQ__AdditionalDiscountAmount__c | Currency (12, 2) | Additional customer discount for this subscription expressed as an absolute amount. |
| Billing Frequency | SBQQ__BillingFrequency__c | Picklist | Defines the billing frequency. Values are as follows.
|
| Billing Type | SBQQ__BillingType__c | Picklist |
|
| Bundled | SBQQ__Bundled__c | Checkbox | The subscription is included in a bundle. Bundled line items have a price of 0, and price and quantity can’t be edited. |
| Charge Type | SBQQ__ChargeType__c | Picklist | Values are as follows:
|
| Component Discounted By Package | SBQQ__ComponentDiscountedByPackage__c | Checkbox | Fixes additional discount for this component to the parent bundle discount. |
| Component Percent of Total Scope | SBQQ__ComponentSubscriptionScope__c | Picklist | Subscription scope set at the component level. This field overrides the subscription scope copied from the product. Values are as follows.
|
| Contract | SBQQ__Contract__c | Lookup (Contract) | Contract that governs this subscription. |
| Contract # | SBQQ__ContractNumber__c | Formula (Text) | Number of the associated contract. |
| Credit Product ID | SBQQ__CreditProductId__c | Formula (Text) | ID of upgrade credit product for this subscription. |
| Customer Price | SBQQ__CustomerPrice__c | Currency (12, 2) | Customer unit price for the product quoted by this line item. This price is the net price, excluding any partner discounts. |
| Dimension Type | SBQQ__DimensionType__c | Formula (Text) | Type set on the price dimension. |
| Discount Schedule | SBQQ__DiscountSchedule__c | Lookup (Discount Schedule) | Specify discounts in terms of percentage or amount to be discounted from the product's price using quantity purchased or term. Set quantity or term ranges in tiers of different discount percentages. The discount is applied to the list price, and the resulting total is stored in the regular price. |
| Discount Schedule Type | SBQQ__DiscountScheduleType__c | Picklist | Discount schedule type. Copied from the Type field in the associated discount schedule. Must be a stored value because it’s used in rollup formula fields. Values are as follows.
|
| Distributor Discount | SBQQ__DistributorDiscount__c | Percent (3, 2) | This discount is applied to the partner price and reflected in the net price. |
| Dynamic Option ID | SBQQ__DynamicOptionId__c | Text (40) | Contains the feature ID and product ID to identify the feature and optional SKU associated with this line. |
| End Date | SBQQ__EndDate__c | Formula (Date) | The last date this contract is valid. |
| Has Consumption Schedules | SBQQ__HasConsumptionSchedule__c | Checkbox | Indicates whether this subscription has at least one consumption schedule. |
| List Price | SBQQ__ListPrice__c | Currency (12, 2) | List price of this subscription product. |
| Markup (%) | SBQQ__MarkupRate__c | Percent (6, 2) | Markup on this subscription, if expressed as a percentage. |
| Markup (Amount) | SBQQ__MarkupAmount__c | Currency (12, 2) | Markup on this subscription, if expressed as an amount. |
| Net Price | SBQQ__NetPrice__c | Currency (12, 2) | Net price of this subscription. |
| Number | SBQQ__Number__c | Number (5, 0) | Number indicating the related quote line's position within its group or quote. This value must be unique within the group or quote. |
| Option Discount (%) | SBQQ__OptionDiscount__c | Percent (3, 2) | If this subscription is for an optional SKU, this field captures any discount given to the bundle and extended to the option. |
| Option Discount (Amount) | SBQQ__OptionDiscountAmount__c | Currency (10, 2) | Discount extended on this product because it's part of a bundle. |
| Option Level | SBQQ__OptionLevel__c | Number (5, 0) | Indicates nest level of this option (applies only to lines generated from options). |
| Option Type | SBQQ__OptionType__c | Picklist | Indicates the option type, which is copied from the related product option; determines how quantity is calculated. Types are as follows.
|
| Order Product | SBQQ__OrderProduct__c | Lookup (Order Product) | The order product from which this subscription was generated. Populated only when the subscription is contracted from an order. |
| Original Quantity | SBQQ__BundledQuantity__c | Number (10, 2) | For items with calculated quantities, this field holds the original (user-entered) quantity. |
| Original Quote Line | SBQQ__OriginalQuoteLine__c | Lookup (Quote Line) | Original quote line of the subscription. |
| Original Unit Cost | SBQQ__OriginalUnitCost__c | Currency (12, 2) | Cost of one unit of product quoted on this line item if cost schedules weren’t applied. |
| Package | SBQQ__Bundle__c | Checkbox | Indicates whether this line item represents a bundle, that is, it includes line items for product options on the quote. |
| Package Product Code | SBQQ__PackageProductCode__c | Text (255) | Product code for the bundle. Salesforce CPQ generates this code by appending codes of selected components according to a user-specified pattern. |
| Package Product Description | SBQQ__PackageProductDescription__c | Rich Text Area (32,000) | Dynamic product description generated from the components inside this bundle. |
| Parent Product | SBQQ__RequiredByProduct__c | Lookup (Product) | Parent product of this subscription. |
| Partner Discount | SBQQ__PartnerDiscount__c | Percent (3, 2) | If your company sells through a channel or VARI, a partner discount can be given on a quote or individual product line item. Partner discounts are applied after all automatic and discretionary discounts. The partner discount is taken into account in the partner price. |
| Price Dimension | SBQQ__Dimension__c | Lookup (Price Dimension) | Price dimension associated with this subscription. |
| Pricing Method | SBQQ__PricingMethod__c | Picklist | Indicates how the price for the related line item is calculated. "List" = discount is subtracted from list price. "Cost" = markup is added to cost. Values are as follows.
|
| Product | SBQQ__Product__c | Lookup (Product) | Product used to sell the subscription. |
| Product ID | SBQQ__ProductId__c | Formula (Text) | Convenience field to support integration with Service Cloud. |
| Product Name | SBQQ__ProductName__c | Formula (Text) | Name of the product referenced by this subscription. |
| Product Option | SBQQ__ProductOption__c | Lookup (Product Option) | Product option that generated this subscription (if any). |
| Product Subscription Type | SBQQ__ProductSubscriptionType__c | Picklist | By default, this field is mapped from the product. For any legacy quote line, this field is null. |
| Prorate Multiplier | SBQQ__ProrateMultiplier__c | Number (4, 4) | Calculated ratio used to compute prorated price. |
| Quantity | SBQQ__Quantity__c | Number (10, 2) | Purchased quantity of this subscription. |
| Quote Line | SBQQ__QuoteLine__c | Lookup (Quote Line) | Quote line that generated the subscription. |
| Regular Price | SBQQ__RegularPrice__c | Currency (12, 2) | Regular price of this subscription. |
| Renewal Price | SBQQ__RenewalPrice__c | Currency (12, 2) | 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. |
| Renewal Product ID | SBQQ__RenewalProductId__c | Formula (Text) | Product ID of the renewal subscription. |
| Renewal Product Option ID | SBQQ__RenewalProductOptionId__c | Formula (Text) | ID of the renewal product option defined on the product option. |
| Renewal Product Option Product ID | SBQQ__RenewalProductOptionProductId__c | Formula (Text) | ID of the optional SKU defined on the renewal product option. |
| Renewal Product Option Sub Pricing | SBQQ__RenewalProductOptionSubscriptionPricing__c | Formula (Text) | Subscription pricing defined on the optional SKU of the renewal product option. |
| Renewal Quantity | SBQQ__RenewalQuantity__c | Number (10, 2) | Quantity of the subscription product to be renewed. |
| Renewal Uplift (%) | SBQQ__RenewalUpliftRate__c | Percent (8, 3) | Rate of renewal price increases. |
| Renewed Date | SBQQ__RenewedDate__c | Date | Date when this subscription was renewed. If blank, it hasn’t been renewed. |
| Required By ID | SBQQ__RequiredById__c | Text (18) | The ID of the configured SKU that requires the optional SKU. |
| Revised Subscription | SBQQ__RevisedSubscription__c | Lookup (Subscription) | Lookup to the revised subscription. |
| Root ID | SBQQ__RootId__c | Text (18) (External ID) | The ID of the subscription or asset at the root of the bundle that contains this subscription. |
| Segment End Date | SBQQ__SegmentEndDate__c | Date | For multi-segmented products, the end date from the original segment's associated quote line. |
| Segment Index | SBQQ__SegmentIndex__c | Number (2, 0) | For multi-segmented products, represents the related quote line’s position in the segment table. |
| Segment Key | SBQQ__SegmentKey__c | Text (30) | For multi-segmented products, a shared key used to group multi-dimensional quote line items. |
| Segment Label | SBQQ__SegmentLabel__c | Text (25) | For multi-segmented products, a column header label (for example, "Year 1") associated with the quote line. |
| Segment Quantity | SBQQ__SegmentQuantity__c | Number (10, 2) | For multi-segmented products, the quantity corresponding to the segment's original quote line. |
| Segment Start Date | SBQQ__SegmentStartDate__c | Date | For multi-segmented products, the start date from the original segment's quote line. |
| Segment Uplift | SBQQ__SegmentUplift__c | Percent (7, 2) | For multi-segmented products, the uplift percentage from the original segment's quote line item. |
| Segment Uplift (Amount) | SBQQ__SegmentUpliftAmount__c | Currency (10, 2) | For multi-segmented products, the uplift amount from the original segment's quote line. |
| Special Price | SBQQ__SpecialPrice__c | Currency (12, 2) | Special price for this subscription. |
| Start Date | SBQQ__StartDate__c | Formula (Date) | The first effective date of this subscription. |
| Subscription End Date | SBQQ__SubscriptionEndDate__c | Date | 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. |
| Subscription Start Date | SBQQ__SubscriptionStartDate__c | Date | 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. |
| Subscription Type | SBQQ__SubscriptionType__c | Picklist | By default, this field is mapped from the product. For any legacy quote line item, the value is null. For a new quote line item, the value is conditionally mapped from the default subscription type. The conditional picklist values are as follows.
|
| Term Discount Schedule | SBQQ__TermDiscountSchedule__c | Lookup (Discount Schedule) | Schedule for discounts based on subscription term. |
| Terminated Date | SBQQ__TerminatedDate__c | Date | Date the subscription was terminated. Populated automatically when covered asset is upgraded. |
| Unit Cost | SBQQ__UnitCost__c | Currency (12, 2) | Unit cost of the subscription. |
Did this article solve your issue?
Let us know so we can improve!
