You are here:
Usage Summary and Usage Fields
A usage summary shows the total quantity and value of related usages, and the date ranges for including usage records. The usage record shows the number of usage charges over a predefined time period. A user can override the precalculated usage amounts with their own values. With certain page layout and field-level security settings, some fields aren’t visible or editable. (Salesforce Billing Managed Package)
Required Editions
| Available in: All Salesforce Billing Editions |
Usage Summary Fields
| Usage Summary Field | Description |
|---|---|
| Applied Unit Price | This field isn’t supported. |
| Billed Quantity | The total quantity of this summary’s usage that Salesforce Billing has billed. The billed quantity can contain usage from one or more usage records. |
| Billed Revenue | This field isn’t supported. |
| Included Unbilled Usage | Used only when Order Product Charge Type is defined as Usage. Not used when a usage summary has an order product consumption schedule. |
| Included Unbilled Exhausted | Used only when Order Product Charge Type is defined as Usage. Not used when a usage summary has an order product consumption schedule. |
| Invoice | The invoice that contains an invoice line for this usage summary. |
| Invoice Line | The invoice line that represents invoiced billings from this usage summary. |
| Invoice Run | The invoice run that created an invoice line for this usage summary. |
| Invoice Run Processing Status | Shows the order product status as evaluated by the invoice run:
|
| Invoice Run Status (Index) | Text string that mirrors the value of the Invoice Run Processing Status picklist. Users must not edit this system field. |
| Matching Attribute | Populated from the consumption schedule. Usages are rated against usage summaries where the Matching ID, Matching Attribute, and Unit of Measure fields all match. When Charge Type equals Usage, legacy usage pricing ignores this field. |
| Matching ID | Salesforce Billing uploads usage only to usage summaries with matching IDs. We recommend creating a workflow rule that populates your usages and usage summaries based on certain criteria. |
| Next Billing Date | The date that this usage summary is due for billing. The Target Date on an invoice run must be after this date for the usage summary to be invoiced. When you use Bill Now, the effective target date must be after this date. |
| Override Item Consumption Schedule | Lookup to the order item consumption schedule for pricing. Populated only for products with consumption schedules. |
| Override Status | When this status is set to Canceled:
|
| Override Summary End Date | Salesforce Billing automatically calculates your summary’s start and end dates based on your order product’s next billing date and billing frequency. However, you can enter a date in this field to override the default summary end date. |
| Prerated Amount | The total value of prerated usage across all of this summary’s usage records. When users enter a prerated amount on a usage record, Salesforce Billing uses that value for the usage’s total rather than the standard calculation of usage unit price * usage quantity. |
| Prerated Quantity | The total value of prerated usage across all of this summary’s usage records. When users enter a prerated amount on a usage record, Salesforce Billing uses that value for the usage’s total rather than the standard calculation of usage unit price * usage quantity. |
| Source |
The source is automatically set to Standard when created by the managed package. Use External when creating custom usage summaries. See Custom Usage Summaries |
| Status | Valid values are:
|
| Summary Start Date | Salesforce Billing includes usage in a usage summary if the records have matching IDs and the usage’s processing date falls within the summary’s start and end dates. The first usage summary start date inherits the order product’s start date. For more information on how summary start dates are calculated for additional usage summaries, see Changing the Billing Day of Month for Usage Products. |
| Summary End Date | Salesforce Billing includes usage in a usage summary if the records have matching IDs and the usage’s processing date falls within the summary’s start and end dates. |
| Total Revenue | This field isn’t supported. |
| Unbilled Revenue | This field isn’t supported. |
| Unbilled Quantity | The quantity of the summary’s usage that hasn’t been invoiced. |
| Unbilled Subtotal | The amount of the summary’s usage that hasn’t been invoiced. |
| Unit Price | When you invoice the usage summary, the unbilled quantity, unbilled subtotal, and unit price become 0. A usage summary’s unit price is based on where the summary’s total quantity falls within the price schedule. When you use volume price schedules, your usage records and usage summary all have the same unit price. But for tiered price schedules, your usages could have different unit prices than the usage summary based on how their quantity ranges fall in each price tier. When you invoice the last of your usage and the summary’s unbilled quantity becomes 0, the summary’s unit price changes to 0. |
| Unit of Measure | Populated from the consumption schedule. Usages are rated against usage summaries where the Matching ID, Matching Attribute, and Unit of Measure fields all match. When Charge Type equals Usage, legacy usage pricing ignores this field. |
| Usage Count | The number of usage records rated against this usage summary. The number doesn’t change when a rated usage record is deleted. |
Usage Fields
Usage Fields on the Order Product
These fields are used when Charge Type equals Usage and ignored when using a consumption schedule.
| Usage Field | Description |
|---|---|
| Included Usage | The Included Usage field defines a quantity that you provide for free before you begin charging for usage. If your order product has an included quantity of 10 and usages sum to 12, the invoiced quantity is only 2. |
| Usage Floor Quantity | Usage Floor Quantity defines the minimum quantity to charge for, even for little or no usage. For example, if your order product has a usage floor quantity of 10, and usages sum to 7, the invoiced quantity is 10. |

