v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Custom Fields

Retrieve custom field

Retrieve the details of a custom field.

get/custom_fields/{id}

Path parameters

idstring required

The ID of the custom field.

Response

200

keystring required

The key of the custom field.

namestring required

The name of the custom field.

type'select' | 'text' required

The type of the custom field.

object_typesstring[] required

The types of object this custom field can be applied to.

created_atstring date-time required

The UTC timestamp of the creation of the custom field.

Example response

{
  "key": "customer_country",
  "name": "Customer country",
  "type": "select",
  "object_types": [
    "payment_order",
    "external_account"
  ],
  "values": [
    {
      "key": "fr",
      "name": "France"
    },
    {
      "key": "uk",
      "name": "United-Kingdom"
    }
  ],
  "created_at": "2024-01-03T11:53:19.734182Z"
}