Docs
Basic Features
Space Concept
Permission Concept
Manual Tasks
Payment
Overview
Integration Modes
Processors
Debt Collection
Debt Collection
Debt Collectors
Subscription
Quick Start
Subscriptions
Products
Coupons
Subscribers
Customize
Document Handling
Resources
Twig Templates
Email Handling
Connect
Connected Services
Printing
Slack
Lightspeed eCom
Shopify
Shopify Payment
Wix
Ecwid
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Documentation
Documentation
English (United States)
Français (France)
Deutsch (Deutschland)
Italiano (Italia)
Metric
Close
API Documentation
Metric
A metric represents the usage of a resource that can be measured.
States
Create
The create state indicates that the Metric is in creation.
Active
The active state indicates that the Metric is active and may be used.
Inactive
The inactive state indicates that the Metric is inactive and may not be used.
Deleting
The deleting state indicates that the Metric is in the process to be deleted.
Deleted
The deleted state marks the entity for purging from the database.
Properties
Description
The localized description of the metric that is displayed to the customer.
ID
A unique identifier for the object.
Linked Space ID
The ID of the space this object belongs to.
Name
The localized name of the metric that is displayed to the customer.
Planned Purge Date
The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
State
The object's current state.
Type
The type of the metric.
Version
The version is used for optimistic locking and incremented whenever the object is updated.