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

Add Key

Create a custom field key
client.V1.CustomFields.AddKey(ctx, body) error
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.

Parameters
bodyEnforceUniquenessfieldEntityfieldKeyfieldV1CustomFieldAddKeyParams
Hide ParametersShow Parameters
EnforceUniquenessfield
param.Field[bool]
Entityfield
Hide ParametersShow Parameters
V1CustomFieldAddKeyParamsEntityAlertconst
"alert"
V1CustomFieldAddKeyParamsEntityBillableMetricconst
"billable_metric"
V1CustomFieldAddKeyParamsEntityChargeconst
"charge"
V1CustomFieldAddKeyParamsEntityCommitconst
"commit"
V1CustomFieldAddKeyParamsEntityContractCreditconst
"contract_credit"
V1CustomFieldAddKeyParamsEntityContractProductconst
"contract_product"
V1CustomFieldAddKeyParamsEntityContractconst
"contract"
V1CustomFieldAddKeyParamsEntityCreditGrantconst
"credit_grant"
V1CustomFieldAddKeyParamsEntityCustomerPlanconst
"customer_plan"
V1CustomFieldAddKeyParamsEntityCustomerconst
"customer"
V1CustomFieldAddKeyParamsEntityDiscountconst
"discount"
V1CustomFieldAddKeyParamsEntityInvoiceconst
"invoice"
V1CustomFieldAddKeyParamsEntityPlanconst
"plan"
V1CustomFieldAddKeyParamsEntityProfessionalServiceconst
"professional_service"
V1CustomFieldAddKeyParamsEntityProductconst
"product"
V1CustomFieldAddKeyParamsEntityRateCardconst
"rate_card"
V1CustomFieldAddKeyParamsEntityScheduledChargeconst
"scheduled_charge"
V1CustomFieldAddKeyParamsEntitySubscriptionconst
"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.AddKey(context.TODO(), metronome.V1CustomFieldAddKeyParams{
    EnforceUniqueness: metronome.F(true),
    Entity: metronome.F(metronome.V1CustomFieldAddKeyParamsEntityCustomer),
    Key: metronome.F("x_account_id"),
  })
  if err != nil {
    panic(err.Error())
  }
}