Get Custom Field Definition

Fetch an custom field definition

GET/custom_field_definitions/{custom_field_definition_id}

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the Get Custom Field Definition action (under custom_field_definition).
Fill in the fields below, then reference the result from later steps as {{getCustomFieldDefinition.response.data}}.

Request

Path parameters

custom_field_definition_idstringrequired

Custom Field Definition ID

Response

Returns 200 with an object. Read it in later steps with {{getCustomFieldDefinition.response.data.<field>}}.

idstring

objectstring

related_typestring

One ofaccountitemplansubscriptioncharge

namestring

Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.

user_accessstring

The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.

One ofapi_onlyread_onlywriteset_only

display_namestring

Used to label the field when viewing and editing the field in Recurly's admin UI.

tooltipstring

Displayed as a tooltip when editing the field in the Recurly admin UI.

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.

json

{
  "id": "string",
  "object": "string",
  "related_type": "account",
  "name": "string",
  "user_access": "api_only",
  "display_name": "string",
  "tooltip": "string",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z",
  "deleted_at": "2025-01-01T00:00:00Z"
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.

Was this page helpful?