List Event Fields

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/events/fields \
  --header 'Authorization: Bearer <token>'

{
  "events": {
    "configuration.commitment.created": {
      "new.accountCode": "string",
      "new.accountId": "string",
      "new.accountingProductId": "string",
      "new.amount": "double",
      "new.amountFirstBill": "double",
      "new.amountPrePaid": "double",
      "new.amountSpent": "double",
      "new.billEpoch": "string",
      "new.billingInterval": "int",
      "new.billingOffset": "int",
      "new.billingPlanId": "string",
      "new.commitmentFeeBillInAdvance": "boolean",
      "new.commitmentFeeDescription": "string",
      "new.commitmentUsageDescription": "string",
      "new.contractId": "string",
      "new.currency": "string",
      "new.customFields": "map",
      "new.endDate": "string",
      "new.feeDates": "array",
      "new.id": "string",
      "new.overageDescription": "string",
      "new.overageSurchargePercent": "double",
      "new.productIds": "array",
      "new.startDate": "string"
    }
  }
}

List Event Fields

List Event Fields.

Retrieves a list of Fields for a specific Event Type. These Fields are dynamic and forward compatibile, enabling calculation operations on the Event schema.

Notes:

In many of the Response schema for this call, such as when you retrieve the Fields for a configuration.commitment.created Event Type, new represents the attributes the newly created object has. The Response to a call to retrieve the Fields for a configuration.commitment.updated Event Type will contain Field values for both the old and new objects. The Response to a call to retrieve the Fields for a configuration.commitment.deleted Event Type will only contain old Fields, for values at point of deletion. Having access to reference both new and old Field values for an object can be very useful if you want to base a Notification rule on an Event and include a calculation in the rule that, for example, compares new values with old - for example, trigger a Notification only when a Commitment has been updated and the new value for the amount is at least $1,000 greater than the old value.
Some Event types will show customFields even though the specific billing or configuration object the Event is for does not yet have the custom fields functionality implemented. For these Events, their customFields values will not be populated until such time as the custom fields functionality is implemented for them

GET

organizations

{orgId}

events

fields

List Event Fields

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/events/fields \
  --header 'Authorization: Bearer <token>'

{
  "events": {
    "configuration.commitment.created": {
      "new.accountCode": "string",
      "new.accountId": "string",
      "new.accountingProductId": "string",
      "new.amount": "double",
      "new.amountFirstBill": "double",
      "new.amountPrePaid": "double",
      "new.amountSpent": "double",
      "new.billEpoch": "string",
      "new.billingInterval": "int",
      "new.billingOffset": "int",
      "new.billingPlanId": "string",
      "new.commitmentFeeBillInAdvance": "boolean",
      "new.commitmentFeeDescription": "string",
      "new.commitmentUsageDescription": "string",
      "new.contractId": "string",
      "new.currency": "string",
      "new.customFields": "map",
      "new.endDate": "string",
      "new.feeDates": "array",
      "new.id": "string",
      "new.overageDescription": "string",
      "new.overageSurchargePercent": "double",
      "new.productIds": "array",
      "new.startDate": "string"
    }
  }
}

Authorizations

Authorization

string

header

required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

orgId

string

required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

eventName

string

The name of the specific Event Type to use as a list filter, for example configuration.commitment.created.

Response

Returns the list of Fields for an Event Type

events

object

An object containing the list of Fields for the queried Event Type.

See the 200 Response sample where we have queried to get the Fields for the configuration.commitment.created Event Type.

Note: new represents the attributes the newly created object has.

Show child attributes

Retrieve EventResponse

List EventResponse

⌘I