Skip to main content
POST
/
v1
/
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
}'

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
key
string
required
enforce_uniqueness
boolean
required

Response

200

Success