Skip to main content
POST
/
v1
/
customFields
/
listKeys
List custom field keys
curl --request POST \
  --url https://api.metronome.com/v1/customFields/listKeys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entities": [
    "customer"
  ]
}
'
{
  "data": [
    {
      "entity": "customer",
      "key": "x_account_id",
      "enforce_uniqueness": true
    }
  ],
  "next_page": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
next_page
string

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

Body

application/json
​
entities
enum<string>[]

Optional list of entity types to return keys for

Available options:
alert,
billable_metric,
charge,
commit,
contract_credit,
contract_product,
contract,
customer,
discount,
invoice,
product,
rate_card,
scheduled_charge,
subscription,
package_commit,
package_credit,
package_subscription,
package_scheduled_charge

Response

200 - application/json

Success

​
data
object[]
required
​
next_page
string | null
required