Add Key

API Reference

V1

Custom Fields

Create a custom field key

post/v1/customFields/addKey

Add a key to the allow list for a given entity. There is a 100 character limit on custom field keys.

Body Parameters

enforce_uniquenessboolean

entityenum

"alert" OR "billable_metric" OR "charge" OR 15 more

Hide ParametersShow Parameters

"alert"

"billable_metric"

"charge"

"commit"

"contract_credit"

"contract_product"

"contract"

"credit_grant"

"customer_plan"

"customer"

"discount"

"invoice"

"plan"

"professional_service"

"product"

"rate_card"

"scheduled_charge"

"subscription"

keystring

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/customFields/addKey \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "enforce_uniqueness": true,
          "entity": "customer",
          "key": "x_account_id"
        }'