xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Item Consumption Schedule — entity reference
REFERENCE · Last reviewed

Item Consumption Schedule — entity reference

A tiered usage price book for an item. It holds the Item Consumption Rate tiers that would price metered consumption when subscription usage is invoiced. The entity is not reachable in the shipped product: it is in no app and has no seeded layouts or views, and the usage invoicing routine that reads it is not run by any scheduled job, action or screen. When that routine runs, it looks schedules up by item only. Every schedule for the item is included, active ones first and then the most recently updated, and the tiers of all of them are merged into one ladder sorted by lower bound. The customer, customer group, partner, partner group, billing term, billing term unit and unit of measure fields are stored but are not used in pricing.

Fields

FieldLabelTypeRequiredWhat it does
BillingTermBilling TermNumberA billing period length, counted in the Billing Term Unit. It is stored but not used: it does not affect usage pricing or when a usage invoice is raised, which follow the subscription's own billing dates.
BillingTermUnitBilling Term UnitPickListThe unit the billing term is counted in. It has no seeded picklist values and, like the billing term, is not used by any process.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated OnDateAndTimeYes
CustomerAccountGroupIdCustomer Account GroupLookup → AccountGroupMeant to limit the schedule to a group of customers. It is stored but not used: usage pricing matches on the item alone.
CustomerAccountIdCustomer AccountLookup → AccountMeant to limit the schedule to one customer, but usage pricing matches on the item alone, so the schedule applies to every customer of that item.
DescriptionDescriptionTextFree-text notes about the schedule. Not used in pricing.
IdIdGuidYes
IsActiveIs ActiveBooleanOrders the schedules but does not filter them. When an item has several schedules, active ones are taken first, but the tiers of inactive schedules are still merged into the same ladder, so clearing this does not take a schedule out of use. To retire a schedule, delete it or remove its item.
ItemIdItemLookup → ItemThe item whose metered usage this schedule prices. It is the only field usage pricing matches on, so every subscription for this item uses the schedule, whatever its customer or partner. A schedule with no item is never used.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesThe schedule's name, shown in lookups and in the tier records that belong to it.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountGroupIdPartner Account GroupLookup → AccountGroupMeant to limit the schedule to a group of companies. It is stored but not used: usage pricing matches on the item alone.
PartnerAccountIdPartner AccountLookup → AccountThe company the schedule belongs to. It is stored but not used: usage pricing matches on the item alone.
RecordTypeIdRecord TypeGuid, hidden
SubscriptionKeySubscription KeyGuid, hiddenYes
UnitOfMeasureUnit Of MeasurePickListNames the unit the tier bounds are expressed in. It is a label only: no conversion is applied between it and the usage quantity being priced. It has no seeded picklist values.
UpdatedDateTimeUpdated OnDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record