Rebilly API Docs

Retrieve a custom field

Retrieves a schema of a specified custom field for a specified resource type.

SecuritySecretApiKey or JWT

Request

resource required	string Resource type string. Enum: "customers" "payment-instruments" "subscriptions" "transactions" "websites" "products" "plans" "bump-offers"
name required	string <= 60 characters ^[\w-]+$ ID of the custom field.

Responses

200

Custom field schema retrieved.

type

required

string

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

Enum:	Description
array	Array of strings with up to 255 characters. Maximum size is 1000 elements.
boolean	Specifies a `true` or `false` value.
date	String in full-date format (YYYY-MM-DD).
datetime	String in date-time format (YYYY-MM-DDTHH:MM:SSZ).
integer	Cardinal value of between `-2^31` and `2^31-1`.
number	Float value. This field also accepts cardinal values which are interpreted as float.
string	Regular string of up to 255 characters.
monetary	A map of 3-letter currency, code, and amount. Example: `{"currency": "EUR", "amount": 25.30}`.

name

string

Name of the custom field.

description

string

Description of the custom field.

additionalSchema

any

Additional schema which adds additional values constrains.

Additional parameters which can be added according to type:

Parameter name	Types	Description
`allowedValues`	string, array	List of allowed values.
`maxLength`	string	Maximum allowed length of a string. A maximum length of 4000 characters can be configured. By default, this value is set to 255.

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.

404

Resource 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": [{"href": "string",
"rel": "self"
}
]
}