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

Remove Key

Delete a custom field key
client.V1.CustomFields.RemoveKey(ctx, body) error
post/v1/customFields/removeKey

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

Parameters
bodyEntityfieldKeyfieldV1CustomFieldRemoveKeyParams
Hide ParametersShow Parameters
Entityfield
Hide ParametersShow Parameters
V1CustomFieldRemoveKeyParamsEntityAlertconst
"alert"
V1CustomFieldRemoveKeyParamsEntityBillableMetricconst
"billable_metric"
V1CustomFieldRemoveKeyParamsEntityChargeconst
"charge"
V1CustomFieldRemoveKeyParamsEntityCommitconst
"commit"
V1CustomFieldRemoveKeyParamsEntityContractCreditconst
"contract_credit"
V1CustomFieldRemoveKeyParamsEntityContractProductconst
"contract_product"
V1CustomFieldRemoveKeyParamsEntityContractconst
"contract"
V1CustomFieldRemoveKeyParamsEntityCreditGrantconst
"credit_grant"
V1CustomFieldRemoveKeyParamsEntityCustomerPlanconst
"customer_plan"
V1CustomFieldRemoveKeyParamsEntityCustomerconst
"customer"
V1CustomFieldRemoveKeyParamsEntityDiscountconst
"discount"
V1CustomFieldRemoveKeyParamsEntityInvoiceconst
"invoice"
V1CustomFieldRemoveKeyParamsEntityPlanconst
"plan"
V1CustomFieldRemoveKeyParamsEntityProfessionalServiceconst
"professional_service"
V1CustomFieldRemoveKeyParamsEntityProductconst
"product"
V1CustomFieldRemoveKeyParamsEntityRateCardconst
"rate_card"
V1CustomFieldRemoveKeyParamsEntityScheduledChargeconst
"scheduled_charge"
V1CustomFieldRemoveKeyParamsEntitySubscriptionconst
"subscription"
Keyfield
param.Field[string]
package main

import (
  "context"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  err := client.V1.CustomFields.RemoveKey(context.TODO(), metronome.V1CustomFieldRemoveKeyParams{
    Entity: metronome.F(metronome.V1CustomFieldRemoveKeyParamsEntityCustomer),
    Key: metronome.F("x_account_id"),
  })
  if err != nil {
    panic(err.Error())
  }
}