Skip to content

MeteredUsage

DocType representing a persisted usage event.

Used by the metering adapter to track tenant usage.

Source: metered_usage.py

Field Type Required Description Validators
tenant_id str Unique tenant identifier -
feature_name str Name of the metered feature -
quantity float Amount of usage consumed -
timestamp datetime When the usage occurred -
metadata_dict None Optional context or dimensions -
Setting Value
Submittable False
Track Changes True

Controller hooks are implemented in *_controller.py files. Available lifecycle hooks:

  • validate() - Called before save, raise exceptions for validation errors
  • before_insert() - Called before inserting a new document
  • after_insert() - Called after successfully inserting
  • before_save() - Called before saving (insert or update)
  • after_save() - Called after saving
  • before_delete() - Called before deleting
  • after_delete() - Called after deleting