Recurly · Schema

ExternalSubscriptionUpdate

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
external_product_reference object
external_id string Id of the subscription in the external system, i.e. Apple App Store or Google Play Store.
last_purchased string When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
auto_renew boolean An indication of whether or not the external subscription will auto-renew at the expiration date.
state string External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.
app_identifier string Identifier of the app that generated the external subscription.
quantity integer An indication of the quantity of a subscribed item's quantity.
activated_at string When the external subscription was activated in the external platform.
expires_at string When the external subscription expires in the external platform.
trial_started_at string When the external subscription trial period started in the external platform.
trial_ends_at string When the external subscription trial period ends in the external platform.
imported boolean An indication of whether or not the external subscription was being created by a historical data import.
View JSON Schema on GitHub

JSON Schema

recurly-external-subscription-update-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-external-subscription-update-schema.json",
  "title": "ExternalSubscriptionUpdate",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-external-subscription-api-openapi.yml#/components/schemas/ExternalSubscriptionUpdate",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "external_product_reference": {
          "$ref": "#/$defs/ExternalProductReferenceUpdate"
        }
      }
    },
    {
      "$ref": "#/$defs/ExternalSubscriptionBase"
    }
  ],
  "$defs": {
    "ExternalProductReferenceBase": {
      "type": "object",
      "properties": {
        "reference_code": {
          "type": "string",
          "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.",
          "maxLength": 255
        },
        "external_connection_type": {
          "$ref": "#/$defs/ExternalProductReferenceConnectionType"
        }
      }
    },
    "ExternalProductReferenceConnectionType": {
      "type": "string",
      "description": "Represents the connection type. One of the connection types of your enabled App Connectors"
    },
    "ExternalProductReferenceUpdate": {
      "allOf": [
        {
          "$ref": "#/$defs/ExternalProductReferenceBase"
        }
      ]
    },
    "ExternalSubscriptionBase": {
      "type": "object",
      "properties": {
        "external_id": {
          "type": "string",
          "title": "External Id",
          "description": "Id of the subscription in the external system, i.e. Apple App Store or Google Play Store."
        },
        "last_purchased": {
          "type": "string",
          "format": "date-time",
          "title": "Last purchased",
          "description": "When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade."
        },
        "auto_renew": {
          "type": "boolean",
          "title": "Auto-renew",
          "description": "An indication of whether or not the external subscription will auto-renew at the expiration date.",
          "default": false
        },
        "state": {
          "type": "string",
          "description": "External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.",
          "default": "active"
        },
        "app_identifier": {
          "type": "string",
          "title": "App identifier",
          "description": "Identifier of the app that generated the external subscription."
        },
        "quantity": {
          "type": "integer",
          "title": "Quantity",
          "description": "An indication of the quantity of a subscribed item's quantity.",
          "default": 1,
          "minimum": 0
        },
        "activated_at": {
          "type": "string",
          "format": "date-time",
          "title": "Activated at",
          "description": "When the external subscription was activated in the external platform."
        },
        "expires_at": {
          "type": "string",
          "format": "date-time",
          "title": "Expires at",
          "description": "When the external subscription expires in the external platform."
        },
        "trial_started_at": {
          "type": "string",
          "format": "date-time",
          "title": "Trial started at",
          "description": "When the external subscription trial period started in the external platform."
        },
        "trial_ends_at": {
          "type": "string",
          "format": "date-time",
          "title": "Trial ends at",
          "description": "When the external subscription trial period ends in the external platform."
        },
        "imported": {
          "type": "boolean",
          "title": "Import",
          "description": "An indication of whether or not the external subscription was being created by a historical data import.",
          "default": false
        }
      }
    }
  }
}

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-subscription-update"
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.