Create Billable Metric

POST

metrics

{
  "name": "Amex Consumer",
  "description": "No. of Amex Consumer Cards",
  "eventName": "transactions",
  "filterGroups": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  }
}

{
  "id": "mtr_02zBU3PJ3hJurtFSxDD3Ol",
  "description": "No. of Amex Consumer Cards",
  "name": "Amex Consumer",
  "eventName": "transactions",
  "filters": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  },
  "createdAt": "2025-02-24T12:09:05.350876Z",
  "updatedAt": "2025-02-24T12:09:05.350877Z",
  "organizationID": "8641473c-2d34-46c6-b712-c893934fc8fb"
}

Allows you to create a billable metric out of the raw ingested events.

Request

{
  "name": "Amex Consumer",
  "description": "No. of Amex Consumer Cards",
  "eventName": "transactions",
  "filterGroups": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  }
}

string

required

The name of the billable metric. This should be clear and concise to represent the usage you are tracking.

string

required

A detailed explanation of what the metric measures, such as the number of specific customer transactions.

string

required

The name of the event that triggers the metric. This event represents a customer action or transaction.

[]object

An array of filter groups used to refine which events contribute to the metric. Filters allow you to narrow down events based on specific properties.

Show Filter Group Properties

string

required

The logical operator for the group (e.g., “and”, “or”) that combines the filters.

[]object

required

An array of individual filters within the group.

Show Filter Properties

string

required

The event property to filter by.

string

required

The condition to apply (e.g., “equal”, “contains”).

string

required

The value that the event property must match.

object

required

The aggregation settings for the metric. This defines how event data is calculated to produce the final metric value.

Show Aggregation Properties

string

required

The aggregation method to apply (e.g., “count”, “sum”, “average”, “min”, “max”).

string

required

The event property to aggregate. This is used when the aggregation method requires a numeric field.

Response

string

The unique identifier for the metric.

string

A brief description of what the metric measures.

string

The name of the metric.

string

The event that triggers the metric.

[]object

An array of filter groups applied to the metric to narrow down the events counted.

Show Filter Group Properties

string

The logical operator (e.g., “and”) used to combine the filters within the group.

[]object

An array of individual filters within the group.

Show Filter Properties

string

The event property to filter by.

string

The condition to apply (e.g., “equal”).

string

The value that the event property must match.

object

The aggregation settings that define how the events are calculated to produce the metric value.

Show Aggregation Properties

string

The aggregation method to apply (e.g., “sum”).

string

The event property that is aggregated.

datetime

The timestamp when the metric was created.

datetime

The timestamp when the metric was last updated.

string

The unique identifier for the organization associated with the metric.

{
  "id": "mtr_02zBU3PJ3hJurtFSxDD3Ol",
  "description": "No. of Amex Consumer Cards",
  "name": "Amex Consumer",
  "eventName": "transactions",
  "filters": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  },
  "createdAt": "2025-02-24T12:09:05.350876Z",
  "updatedAt": "2025-02-24T12:09:05.350877Z",
  "organizationID": "8641473c-2d34-46c6-b712-c893934fc8fb"
}

Get Billable Metric

⌘I

{
  "name": "Amex Consumer",
  "description": "No. of Amex Consumer Cards",
  "eventName": "transactions",
  "filterGroups": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  }
}

{
  "id": "mtr_02zBU3PJ3hJurtFSxDD3Ol",
  "description": "No. of Amex Consumer Cards",
  "name": "Amex Consumer",
  "eventName": "transactions",
  "filters": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  },
  "createdAt": "2025-02-24T12:09:05.350876Z",
  "updatedAt": "2025-02-24T12:09:05.350877Z",
  "organizationID": "8641473c-2d34-46c6-b712-c893934fc8fb"
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets

Create Billable Metric

Request

Response

​Request

​Response

Request

Response