Delete Values

API Reference

V1

Custom Fields

Delete custom fields

client.v1.customFields.deleteValues(CustomFieldDeleteValuesParamsbody, RequestOptionsoptions?): void

post/v1/customFields/deleteValues

Deletes one or more custom fields on an instance of a Metronome entity.

Parameters

bodyentityunionentity_idstringkeysarrayCustomFieldDeleteValuesParams

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"

entity_idstring

formatuuid

keysarray

Array<string>

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

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

await client.v1.customFields.deleteValues({
  entity: 'customer',
  entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
  keys: ['x_account_id'],
});