# Custom Fields

## Add Key

**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.

## Delete Values

**post** `/v1/customFields/deleteValues`

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

## List Keys

**post** `/v1/customFields/listKeys`

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

### Returns

- **data:** `array of object`

  - **enforce\_uniqueness:** `boolean`

  - **entity:** `"alert" OR "billable_metric" OR "charge" OR 15 more`

    - `"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"`

  - **key:** `string`

- **next\_page:** `string`

## Remove Key

**post** `/v1/customFields/removeKey`

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

## Set Values

**post** `/v1/customFields/setValues`

Sets one or more custom fields on an instance of a Metronome entity. If a key/value pair passed in this request matches one already set on the entity, its value will be overwritten. Any key/value pairs that exist on the entity that do not match those passed in this request will remain untouched. This endpoint is transactional and will update all key/value pairs or no key/value pairs. Partial updates are not supported. There is a 200 character limit on custom field values.