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/Subscription Usage — entity reference
REFERENCE · Last reviewed

Subscription Usage — entity reference

A raw usage entry: a quantity of an item, and optionally one of its features, consumed by an account or asset. It is a record-keeping entity only. It is in no app, so no menu opens it, and no screen, action, job or service reads it. Usage entries are never totalled, priced or invoiced. Usage-based billing works from Subscription Usage Summary records instead, and nothing builds those summaries from these entries. The shipped create form has no Subscription field, so an entry typed on the form is not linked to a subscription. To use the entity as a manual usage log, an administrator adds it to an app (Setup, Design Studio, Apps, Manage Items) and adds Subscription to its layouts.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe customer account that consumed the usage. Optional, and for reference only. Nothing reads it.
AssetIdAssetLookup → AssetThe asset (for example an installed machine or meter) on which the usage was recorded. Optional, and for reference only.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
IdIdGuidYes
ItemFeatureIdItem FeatureLookup → ItemFeatureOne feature of the item, when usage is metered per feature. Optional, and for reference only.
ItemIdItemLookup → ItemThe item whose usage is recorded. Optional. It is not checked against the subscription's item.
ModifiedByIdModified ByLookup → UserAccountYes
NameUsage NameTextYesThe entry's name, typed by you. It is required and is not numbered automatically.
OwnerIdOwnerLookup → UserAccountYes
QuantityQuantityDecimalThe quantity consumed. It defaults to 0. It is not added to any summary or invoice.
RecordTypeIdRecord TypeGuid, hidden
SubscriptionIdSubscriptionLookup → SubscriptionThe subscription the usage belongs to. It is not on the shipped create form, so only an import, the API or a layout an administrator has edited can set it.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
UsageDateTimeUsage Date TimeDateAndTimeNot stored. The field is on the form, but it has no database column, so a date you enter is dropped on save. Use the record's Created Date or the entry name to record when the usage happened.

Actions

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