Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

Remove Key

API Reference
V1
Custom Fields
Delete a custom field key
client.v1.customFields.removeKey(CustomFieldRemoveKeyParamsbody, RequestOptionsoptions?): void
post/v1/customFields/removeKey

Remove a key from the allow list for a given entity.

Parameters
bodyentityunionkeystringCustomFieldRemoveKeyParams
Hide ParametersShow Parameters
entityunion
"alert" | "billable_metric" | "charge" | 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
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

await client.v1.customFields.removeKey({ entity: 'customer', key: 'x_account_id' });