This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One merchant-defined custom field value carried on a recurring billing contract: the merchant's
field definition, and the value to stamp onto the transactions the contract bills.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
definitionIdrequired
string (uuid)
The merchant custom-field definition this value belongs to, or `null` when
the value could not be matched to one.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
namerequired
string
The name of the merchant's custom-field definition, matched case-insensitively. This is the
canonical key the platform uses for custom fields.nullablemax length 50
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
valuerequired
string
The value captured for the field. At most `TrxCustomFieldConsts.MaxValueLength`
characters and free of control characters.nullablemax length 300
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
legacyKeyrequired
integer (int32)
The v1 API caller's own integer `CustomKey` for this field, preserved verbatim, or
`null` for a value that never came through the v1 facade.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.