Create a custom field key

curl --request POST \
  --url https://api.metronome.com/v1/customFields/addKey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "customer",
  "key": "x_account_id",
  "enforce_uniqueness": true
}
'

import requests

url = "https://api.metronome.com/v1/customFields/addKey"

payload = {
    "entity": "customer",
    "key": "x_account_id",
    "enforce_uniqueness": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entity: 'customer', key: 'x_account_id', enforce_uniqueness: true})
};

fetch('https://api.metronome.com/v1/customFields/addKey', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/customFields/addKey",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entity' => 'customer',
    'key' => 'x_account_id',
    'enforce_uniqueness' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/customFields/addKey"

	payload := strings.NewReader("{\n  \"entity\": \"customer\",\n  \"key\": \"x_account_id\",\n  \"enforce_uniqueness\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/customFields/addKey")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity\": \"customer\",\n  \"key\": \"x_account_id\",\n  \"enforce_uniqueness\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/customFields/addKey")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity\": \"customer\",\n  \"key\": \"x_account_id\",\n  \"enforce_uniqueness\": true\n}"

response = http.request(request)
puts response.read_body

Custom fields

Create a custom field key

Creates a new custom field key for a given entity (e.g. billable metric, contract, alert).

Custom fields are properties that you can add to Metronome objects to store metadata like foreign keys or other descriptors. This metadata can get transferred to or accessed by other systems to contextualize Metronome data and power business processes. For example, to service workflows like revenue recognition, reconciliation, and invoicing, custom fields help Metronome know the relationship between entities in the platform and third-party systems.

Use this endpoint to:

Create a new custom field key for Customer objects in Metronome. You can then use the Set Custom Field Values endpoint to set the value of this key for a specific customer.
Specify whether the key should enforce uniqueness. If the key is set to enforce uniqueness and you attempt to set a custom field value for the key that already exists, it will fail.

Usage guidelines:

Custom fields set on commits, credits, and contracts can be used to scope alert evaluation. For example, you can create a spend threshold alert that only considers spend associated with contracts with custom field key contract_type and value paygo
Custom fields set on products can be used in the Stripe integration to set metadata on invoices.
Custom fields for customers, contracts, invoices, products, commits, scheduled charges, and subscriptions are passed down to the invoice.

POST

customFields

addKey

Create a custom field key

curl --request POST \
  --url https://api.metronome.com/v1/customFields/addKey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "customer",
  "key": "x_account_id",
  "enforce_uniqueness": true
}
'

import requests

url = "https://api.metronome.com/v1/customFields/addKey"

payload = {
    "entity": "customer",
    "key": "x_account_id",
    "enforce_uniqueness": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entity: 'customer', key: 'x_account_id', enforce_uniqueness: true})
};

fetch('https://api.metronome.com/v1/customFields/addKey', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/customFields/addKey",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entity' => 'customer',
    'key' => 'x_account_id',
    'enforce_uniqueness' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/customFields/addKey"

	payload := strings.NewReader("{\n  \"entity\": \"customer\",\n  \"key\": \"x_account_id\",\n  \"enforce_uniqueness\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/customFields/addKey")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity\": \"customer\",\n  \"key\": \"x_account_id\",\n  \"enforce_uniqueness\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/customFields/addKey")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity\": \"customer\",\n  \"key\": \"x_account_id\",\n  \"enforce_uniqueness\": true\n}"

response = http.request(request)
puts response.read_body

Authorizations

Authorization

string

header

required

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

Body

application/json

Add a key to the allow list for an entity

entity

enum<string>

required

Available options:

alert,

billable_metric,

charge,

commit,

contract_credit,

contract_product,

contract,

customer,

discount,

invoice,

product,

rate_card,

scheduled_charge,

subscription,

package_commit,

package_credit,

package_subscription,

package_scheduled_charge

key

string

required

enforce_uniqueness

boolean

required

Response

200

Success

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

Create a custom field key

Use this endpoint to:

Usage guidelines:

Authorizations

Body

Response