Consumption Rate

Consumption rates describe the billing rate for a range of usage within a consumption schedule. All consumption schedules require at least one consumption rate in order to rate usage on a usage product. This object is available in API version 45.0 and later.

The consumption rate sets a quantity-based boundary for usage and defines how much your product costs when its usage falls within that boundary. Consumption rates price usage at a per-unit fee or a flat fee across the entire range of usage.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Fields

Field Details
ConsumptionScheduleId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The consumption schedule that contains the consumption rate.
This is a relationship field.
Relationship Name
ConsumptionSchedule
Relationship Type
Lookup
Refers To
ConsumptionSchedule
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Available only for orgs with the multicurrency feature enabled.
Possible values are:
  • AUD—Australian Dollar
  • CAD—Canadian Dollar
  • GBP—British Pound
  • JPY—Japanese Yen
  • USD—U.S. Dollar
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Description of the consumption rate.
LowerBound
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The lowest quantity of usage for the consumption rate.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Required. Default name of this record. Label is Product Name.
Price
Type
currency
Properties
Create, Filter, Sort, Update
Description
The price for usage that falls within the consumption rate’s bounds.
PricingMethod
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
How Salesforce applies the consumption rate’s price to the total quantity of usage within a usage summary.
Possible values are:
  • FlatFee—Salesforce applies the rate’s price to the entire quantity of usage.
  • PerUnit—Salesforce applies the rate’s price to each individual quantity of usage within the usage summary.
ProcessingOrder
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The order for processing the usage rate across multiple rates. Consumption rates are evaluated beginning with the lowest processing order.
UpperBound
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The highest quantity of usage for the consumption rate.