Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Counter

Create Counter

Create a new Counter.

post/organizations/{orgId}/counters

Path parameters

orgIdstring required

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

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.
codestring

Code for the Counter. A unique short code to identify the Counter.

productIdstring

UUID of the product the Counter belongs to. (Optional) - if left blank, the Counter is Global. A Global Counter can be used to price Plans or Plan Templates belonging to any Product.

namestring required

Descriptive name for the Counter.

unitstring required

User defined label for units shown on Bill line items, and indicating to your customers what they are being charged for.

Response

Return the created Counter

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.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

codestring

Code of the Counter. A unique short code to identify the Counter.

productIdstring

UUID of the product the Counter belongs to. (Optional) - if no productId is returned, the Counter is Global. A Global Counter can be used to price Plans or Plan Templates belonging to any Product.

namestring

Name of the Counter.

unitstring

Label for units shown on Bill line items, and indicating to customers what they are being charged for.