Custom fields

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. Depending on the resource on which the custom field is added, it may be available in the Rebilly UI.

Example: A custom field called preferredCommunicationChannel is added to the customer resource. It has two allowed values, which are 'email' and 'phone'.

{
  "customFields": {
      "preferredCommunicationChannel": "email"
  }
}

For detailed information on Rebilly resources, see Resources.

Operations

Retrieve custom fields

Request

Retrieves the custom fields 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"
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/custom-fields/{resource}?limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Schema of custom fields retrieved.

Bodyapplication/json
Array [
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": { … },
    "_links": [ … ]
  }
]