younifyd
Menu

List Custom Field Definitions

List a site's custom field definitions

GET/custom_field_definitions

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List Custom Field Definitions action (under custom_field_definition).
  3. Fill in the fields below, then reference the result from later steps as {{listCustomFieldDefinitions.response.data}}.

Request

Query parameters

idsarray<string>

Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.

limitinteger

Limit number of records 1-200.

Default 20

orderstring

Sort order.

One ofascdescDefault "desc"

sortstring

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

One ofcreated_atupdated_atDefault "created_at"

begin_timestring (date-time)

Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

end_timestring (date-time)

Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

related_typestring

Filter by related type.

One ofaccountitemplansubscriptioncharge

Response

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

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>
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
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "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.