Recurly · Schema

Custom field definition

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
id string
object string
related_type object
name string Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.
user_access object 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
display_name string Used to label the field when viewing and editing the field in Recurly's admin UI.
tooltip string Displayed as a tooltip when editing the field in the Recurly admin UI.
created_at string
updated_at string
deleted_at string 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.
View JSON Schema on GitHub

JSON Schema

recurly-custom-field-definition-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-custom-field-definition-schema.json",
  "title": "Custom field definition",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-custom-field-definition-api-openapi.yml#/components/schemas/CustomFieldDefinition",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "Custom field definition ID",
      "readOnly": true
    },
    "object": {
      "type": "string",
      "title": "Object type",
      "readOnly": true
    },
    "related_type": {
      "title": "Related Recurly object type",
      "$ref": "#/$defs/RelatedTypeEnum"
    },
    "name": {
      "type": "string",
      "title": "Name",
      "description": "Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.",
      "pattern": "/^[a-z0-9_-]+$/i",
      "maxLength": 50
    },
    "user_access": {
      "title": "User access",
      "description": "The access control applied inside Recurly's admin UI:\n- `api_only` - No one will be able to view or edit this field's data via the admin UI.\n- `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but\n  editing will only be available via the API.\n- `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.\n- `set_only` - Users with the Customers role will be able to set this field's data via the admin console.\n",
      "$ref": "#/$defs/UserAccessEnum"
    },
    "display_name": {
      "type": "string",
      "title": "Display name",
      "description": "Used to label the field when viewing and editing the field in Recurly's admin UI.",
      "maxLength": 50
    },
    "tooltip": {
      "type": "string",
      "title": "Tooltip description",
      "description": "Displayed as a tooltip when editing the field in the Recurly admin UI.",
      "pattern": "/^[a-z0-9_-]+$/i",
      "maxLength": 255
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created at",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Last updated at",
      "readOnly": true
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "title": "Deleted at",
      "description": "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.",
      "readOnly": true
    }
  },
  "$defs": {
    "RelatedTypeEnum": {
      "type": "string",
      "enum": [
        "account",
        "item",
        "plan",
        "subscription",
        "charge"
      ]
    },
    "UserAccessEnum": {
      "type": "string",
      "enum": [
        "api_only",
        "read_only",
        "write",
        "set_only"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/recurly-custom-field-definition"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.