List Keys

API Reference

Custom Fields

List custom field keys

client.V1.CustomFields.ListKeys(ctx, params) (*, error)

post/v1/customFields/listKeys

List all active custom field keys, optionally filtered by entity type.

Parameters

params

Hide ParametersShow Parameters

NextPagefield

optional

param.Field[string]

Query param: Cursor that indicates where the next page of results should start.

Entitiesfield

optional

param.Field[[]V1CustomFieldListKeysParamsEntity]

Body param: Optional list of entity types to return keys for

Hide ParametersShow Parameters

V1CustomFieldListKeysParamsEntityAlertconst

V1CustomFieldListKeysParamsEntity

"alert"

V1CustomFieldListKeysParamsEntityBillableMetricconst

V1CustomFieldListKeysParamsEntity

"billable_metric"

V1CustomFieldListKeysParamsEntityChargeconst

V1CustomFieldListKeysParamsEntity

"charge"

V1CustomFieldListKeysParamsEntityCommitconst

V1CustomFieldListKeysParamsEntity

"commit"

V1CustomFieldListKeysParamsEntityContractCreditconst

V1CustomFieldListKeysParamsEntity

"contract_credit"

V1CustomFieldListKeysParamsEntityContractProductconst

V1CustomFieldListKeysParamsEntity

"contract_product"

V1CustomFieldListKeysParamsEntityContractconst

V1CustomFieldListKeysParamsEntity

"contract"

V1CustomFieldListKeysParamsEntityCreditGrantconst

V1CustomFieldListKeysParamsEntity

"credit_grant"

V1CustomFieldListKeysParamsEntityCustomerPlanconst

V1CustomFieldListKeysParamsEntity

"customer_plan"

V1CustomFieldListKeysParamsEntityCustomerconst

V1CustomFieldListKeysParamsEntity

"customer"

V1CustomFieldListKeysParamsEntityDiscountconst

V1CustomFieldListKeysParamsEntity

"discount"

V1CustomFieldListKeysParamsEntityInvoiceconst

V1CustomFieldListKeysParamsEntity

"invoice"

V1CustomFieldListKeysParamsEntityPlanconst

V1CustomFieldListKeysParamsEntity

"plan"

V1CustomFieldListKeysParamsEntityProfessionalServiceconst

V1CustomFieldListKeysParamsEntity

"professional_service"

V1CustomFieldListKeysParamsEntityProductconst

V1CustomFieldListKeysParamsEntity

"product"

V1CustomFieldListKeysParamsEntityRateCardconst

V1CustomFieldListKeysParamsEntity

"rate_card"

V1CustomFieldListKeysParamsEntityScheduledChargeconst

V1CustomFieldListKeysParamsEntity

"scheduled_charge"

V1CustomFieldListKeysParamsEntitySubscriptionconst

V1CustomFieldListKeysParamsEntity

"subscription"

Returns

V1CustomFieldListKeysResponsestruct

Hide ParametersShow Parameters

Dataarray

[]V1CustomFieldListKeysResponseData

Hide ParametersShow Parameters

EnforceUniquenessbool

Entity

Hide ParametersShow Parameters

V1CustomFieldListKeysResponseDataEntityAlertconst

"alert"

V1CustomFieldListKeysResponseDataEntityBillableMetricconst

"billable_metric"

V1CustomFieldListKeysResponseDataEntityChargeconst

"charge"

V1CustomFieldListKeysResponseDataEntityCommitconst

"commit"

V1CustomFieldListKeysResponseDataEntityContractCreditconst

"contract_credit"

V1CustomFieldListKeysResponseDataEntityContractProductconst

"contract_product"

V1CustomFieldListKeysResponseDataEntityContractconst

"contract"

V1CustomFieldListKeysResponseDataEntityCreditGrantconst

"credit_grant"

V1CustomFieldListKeysResponseDataEntityCustomerPlanconst

"customer_plan"

V1CustomFieldListKeysResponseDataEntityCustomerconst

"customer"

V1CustomFieldListKeysResponseDataEntityDiscountconst

"discount"

V1CustomFieldListKeysResponseDataEntityInvoiceconst

"invoice"

V1CustomFieldListKeysResponseDataEntityPlanconst

"plan"

V1CustomFieldListKeysResponseDataEntityProfessionalServiceconst

"professional_service"

V1CustomFieldListKeysResponseDataEntityProductconst

"product"

V1CustomFieldListKeysResponseDataEntityRateCardconst

"rate_card"

V1CustomFieldListKeysResponseDataEntityScheduledChargeconst

"scheduled_charge"

V1CustomFieldListKeysResponseDataEntitySubscriptionconst

"subscription"

Keystring

NextPagestring

package main

import (
  "context"
  "fmt"

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

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.CustomFields.ListKeys(context.TODO(), metronome.V1CustomFieldListKeysParams{
    Entities: metronome.F([]metronome.V1CustomFieldListKeysParamsEntity{metronome.V1CustomFieldListKeysParamsEntityCustomer}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

{
  "data": [
    {
      "enforce_uniqueness": true,
      "entity": "alert",
      "key": "key"
    }
  ],
  "next_page": "next_page"
}