Sign in

v10

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

Retrieve Counter

Retrieve a Counter for the given UUID.

get/organizations/{orgId}/counters/{id}

Path parameters

orgIdstring required

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

idstring required

The UUID of the Counter to retrieve.

Response

Return the 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.