Skip to main content
POST
/
companies
/
{company_id}
/
billable_metrics
Create Billable Metric
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/billable_metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "external_name": "<string>",
  "is_billable": true,
  "item_id": "<string>",
  "metering_rule": {
    "aggregator": "<string>",
    "group_keys": [
      "<string>"
    ],
    "property": "<string>",
    "rule": {
      "comparator": {
        "items": [
          {}
        ],
        "left_item": {
          "comparator": {},
          "item_type": "<string>",
          "property": "<string>",
          "value": "<string>"
        },
        "right_item": {
          "comparator": {},
          "item_type": "<string>",
          "property": "<string>",
          "value": "<string>"
        },
        "type": "<string>"
      }
    }
  },
  "name": "<string>"
}'
{
  "company_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "editable": true,
  "external_name": "<string>",
  "id": "<string>",
  "is_billable": true,
  "item_id": "<string>",
  "metering_rule": {
    "aggregator": "<string>",
    "group_keys": [
      "<string>"
    ],
    "property": "<string>",
    "rule": {
      "comparator": {
        "items": [
          {}
        ],
        "left_item": {
          "comparator": {},
          "item_type": "<string>",
          "property": "<string>",
          "value": "<string>"
        },
        "right_item": {
          "comparator": {},
          "item_type": "<string>",
          "property": "<string>",
          "value": "<string>"
        },
        "type": "<string>"
      }
    }
  },
  "name": "<string>",
  "standard": true,
  "state": "<string>",
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
item_id
string
required

The billable item associated with the metric

​
metering_rule
object
required

JSON representation of the metering rule associated with the metric

​
name
string
required

The name of the billable metric

​
description
string

The description of the billable metric

​
external_name
string

The public name of the billable metric

​
is_billable
boolean

Whether to include charges for this metric on invoices

Response

200 - application/json

OK

​
company_id
string

The company ID for the billable metric

​
created_at
string<date-time>

The date the billable metric was created

​
description
string

Any description attached to the billable metric

​
editable
boolean

Whether the billable metric can be further edited

​
external_name
string

The public name of the billable metric

​
id
string

The ID of the billable metric in Maple

​
is_billable
boolean

Whether this is a billable metric

​
item_id
string

The billable item this metric is tied to

​
metering_rule
object

JSON representation of the metering rule associated with the metric

​
name
string

The name of the billable metric

​
standard
boolean

Whether this is a standard billable metric in Maple or a custom billable metric

​
state
string

The state of the metric which can be one of ACTIVE or ARCHIVED

​
type
string

The type of the billable metric which can be one of LICENSE_METRIC, ONETIME_METRIC or CUSTOM_METRIC depending if it is a standard billable metric in Maple or a custom metric

​
updated_at
string<date-time>

The date the billable metric was last updated