Recurly · Schema

ExternalProduct

Product from an external resource such as Apple App Store or Google Play Store.

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
id string System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
object string
name string Name to identify the external product in Recurly.
plan object
created_at string When the external product was created in Recurly.
updated_at string When the external product was updated in Recurly.
external_product_references array List of external product references of the external product.
View JSON Schema on GitHub

JSON Schema

recurly-external-product-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-external-product-schema.json",
  "title": "ExternalProduct",
  "description": "Product from an external resource such as Apple App Store or Google Play Store.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-external-product-api-openapi.yml#/components/schemas/ExternalProduct",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "External product ID.",
      "description": "System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`."
    },
    "object": {
      "type": "string",
      "title": "Object type"
    },
    "name": {
      "type": "string",
      "title": "Name",
      "description": "Name to identify the external product in Recurly."
    },
    "plan": {
      "$ref": "#/$defs/PlanMini"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the external product was created in Recurly."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the external product was updated in Recurly."
    },
    "external_product_references": {
      "type": "array",
      "title": "External Product References",
      "description": "List of external product references of the external product.",
      "items": {
        "$ref": "#/$defs/ExternalProductReferenceMini"
      }
    }
  },
  "$defs": {
    "ExternalProductReferenceMini": {
      "type": "object",
      "title": "External Product Reference details",
      "description": "External Product Reference details",
      "properties": {
        "id": {
          "type": "string",
          "title": "External Product ID",
          "description": "System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`."
        },
        "object": {
          "type": "string",
          "title": "object"
        },
        "reference_code": {
          "type": "string",
          "title": "reference_code",
          "description": "A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store."
        },
        "external_connection_type": {
          "type": "string",
          "title": "external_connection_type",
          "description": "Source connection platform."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the external product was created in Recurly."
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the external product was updated in Recurly."
        }
      }
    },
    "PlanCode": {
      "type": "string",
      "title": "Plan code",
      "description": "Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.",
      "pattern": "/^[a-z0-9_+-]+$/",
      "maxLength": 50
    },
    "PlanMini": {
      "type": "object",
      "title": "Plan mini details",
      "description": "Just the important parts.",
      "properties": {
        "id": {
          "type": "string",
          "title": "Plan ID",
          "maxLength": 13,
          "readOnly": true
        },
        "object": {
          "type": "string",
          "title": "Object type",
          "readOnly": true
        },
        "code": {
          "$ref": "#/$defs/PlanCode"
        },
        "name": {
          "$ref": "#/$defs/PlanName"
        }
      }
    },
    "PlanName": {
      "type": "string",
      "title": "Name",
      "description": "This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.",
      "maxLength": 255
    }
  }
}

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-external-product"
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.