/
Retrieve a custom field

Retrieve a custom field

Request

Retrieves a specified custom field schema for a specified resource.

Security
SecretApiKey or JWT
Path
resourcestringrequired

Type of resource schema.

Enum:"customers""payment-instruments""orders""subscriptions""transactions""websites""products""plans""gateway-accounts""deposit-requests"
namestring, <= 60 characters^[\w-]+$required

ID of the custom field.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/custom-fields/{resource}/{name}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Custom field schema retrieved.

Bodyapplication/json
namestringread-only

Name of the custom field.

typestringrequired

Describes the data type. The custom field type value cannot be changed.

Array of strings with up to 255 characters. The maximum size is 1000 elements.

Value:"array"
Discriminator
descriptionstring or null

Description of the custom field.

isEnabledboolean

Specifies if the custom field is enabled.

Default:true
additionalSchemaobject or null

Additional schema which adds additional values constrains.

Response
{
  "name": "string",
  "type": "array",
  "description": "string",
  "isEnabled": true,
  "additionalSchema": {
    "allowedValues": [ … ],
    "required": true,
    "default": [ … ]
  },
  "_links": [
    { … }
  ]
}