Retrieve a Custom Field

Retrieve a schema of the given Custom Field for the given resource type.

SecuritySecretApiKey or JWT
Request
path Parameters
resource
required
string

The resource type string.

Enum: "customers" "payment-instruments" "subscriptions" "transactions" "websites" "products" "plans" "bump-offers"
name
required
string <= 60 characters ^[\w-]+$

The custom field's identifier string.

Responses
200

A schema of the Custom Field was retrieved successfully.

Response Schema: application/json
type
required
string
Type value Description
array An array of strings up to 255 characters, maximum size is 1000 elements boolean
The type cannot be changed.
Enum: "array" "boolean" "datetime" "integer" "number" "string" "monetary"
name
string

The name of the custom field.

description
string

The custom field description.

additionalSchema
any

Additional parameters which can be added according to type:

Parameter Name Types Description
allowedValues string, array List of allowed values maxLength
The additional schema adds additional constrains for values.
Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/custom-fields/{resource}/{name}
Request samples
$customField = $client->customFields()->load('customers', 'testFieldName');
Response samples
application/json
{
  • "name": "string",
  • "type": "array",
  • "description": "string",
  • "additionalSchema": null,
  • "_links": [
    ]
}