logo

Retrieve custom fields

Retrieves the custom fields schema for a specified resource.

SecurityCustomerJWT
Request
path Parameters
resource
required
string

Type of resource schema.

Enum: "customers" "payment-instruments" "subscriptions" "transactions"
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

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

Responses
200

Schema of custom fields retrieved.

Response Schema: application/json
Array
type
required
string

Describes the data type. Custom field type value cannot be changed.

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

name
string

Name of the custom field.

description
string or null

Description of the custom field.

object or null

Additional schema which adds additional values constrains.

allowedValues
Array of strings

List of allowed values.

required
boolean

Specifies whether this value is required. This value can be combined with any parameter and is available for custom fields of any type.

default
Array of strings

Default value.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/custom-fields/{resource}
Request samples 
Response samples 
application/json
[
  • {
    }
]