Account8

AccountPlan6

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill20

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer20

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping8

ExternalMappings2

IntegrationConfigs12

IntegrationCredentials5

IntegrationDestinations22

IntegrationRuns7

IntegrationTransformations7

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

MeterGroup5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

ServiceUser6

ServiceUserCredentials6

StatementDefinition5

StatementJob5

Support3

TransactionType5

User1

Meter

Create Meter

Changed on Oct 16, 2026

Create a new Meter.

When you create a Meter, you can define two types of field for usage data collection and ingest into the platform:

dataFields to collect raw usage data measures - numeric quantitative data values or non-numeric point data values.
derivedFields to derive usage data measures that are the result of applying a calculation to dataFields, customFields, or system Timestamp fields.

You can also:

Create customFields for a Meter, which allows you to attach custom data to the Meter as name/value pairs.
Create Global Meters, which are not tied to a specific Product and allow you collect to usage data that will form the basis of usage-based pricing across more than one of your Products.

IMPORTANT! - use of PII: The use of any of your end-customers' Personally Identifiable Information (PII) in m3ter is restricted to a few fields on the Account entity. Please ensure that any fields you configure for Meters, such as Data Fields or Derived Fields, do not contain any end-customer PII data. See the Introduction section above for more details.

Request

Base URL
https://api.m3ter.com
Auth
OAuth 2
Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
Client credentialsToken URL /oauth/token
TypeScript
https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/meters/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdstring required

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

Request body

versioninteger

The version number of the entity:

Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level, customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

productIdstring

UUID of the product the Meter belongs to. (Optional) - if left blank, the Meter is global.

groupIdstring

UUID of the group the Meter belongs to. (Optional).

namestring required

Descriptive name for the Meter.

codestring required

Code of the Meter - unique short code used to identify the Meter.

NOTE: Code has a maximum length of 80 characters and must not contain non-printable or whitespace characters (except space), and cannot start/end with whitespace.

Response

Return the created Meter

idstring required

The UUID of the entity.

versioninteger

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

productIdstring

UUID of the Product the Meter belongs to. (Optional) - if blank, the Meter is global.

groupIdstring

UUID of the MeterGroup the Meter belongs to. (Optional).

namestring

Descriptive name for the Meter.

codestring

Code of the Meter - unique short code used to identify the Meter.

dtCreatedstring date-time

The DateTime when the meter was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when the meter was last modified (in ISO-8601 format).

createdBystring

The id of the user who created this meter.

lastModifiedBystring

The id of the user who last modified this meter.

Changes

Oct 16, 202685c514abc692 Revision changes
- breaking
  added subschema #1 subschema #2 to the ///// request property allOf list
- breaking
  the //// request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the //// response's property type changed from no type to object for status
- breaking
  the response's property type changed from no type to object for status
- breaking
  the /// response's property type changed from no type to object for status
Aug 1, 20259f9e5f3dbde7 Revision changes
- breaking
  the response property //////// became optional for the status
- breaking
  the response property //// became optional for the status
- warning
  the //// request property's maxLength was set to 5000

Operation history (3 revisions)