Recurly · Schema

ExternalPaymentPhase

Details of payments in the lifecycle of a subscription from an external resource that is not managed by the Recurly platform, e.g. App Store or Google Play Store.

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
id string System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.
object string
started_at string
ends_at string
starting_billing_period_index integer
ending_billing_period_index integer
offer_type string Type of discount offer given, e.g. "FREE_TRIAL"
offer_name string Name of the discount offer given, e.g. "introductory"
period_count integer Number of billing periods
period_length string Billing cycle length
amount string Allows up to 9 decimal places
currency string 3-letter ISO 4217 currency code.
created_at string When the external subscription was created in Recurly.
updated_at string When the external subscription was updated in Recurly.
View JSON Schema on GitHub

JSON Schema

recurly-external-payment-phase-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-external-payment-phase-schema.json",
  "title": "ExternalPaymentPhase",
  "description": "Details of payments in the lifecycle of a subscription from an external resource that is not managed by the Recurly platform, e.g. 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-payment-phase-api-openapi.yml#/components/schemas/ExternalPaymentPhase",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "External payment phase ID",
      "description": "System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`."
    },
    "object": {
      "type": "string",
      "title": "Object type"
    },
    "started_at": {
      "type": "string",
      "format": "date-time",
      "title": "Started At"
    },
    "ends_at": {
      "type": "string",
      "format": "date-time",
      "title": "Ends At"
    },
    "starting_billing_period_index": {
      "type": "integer",
      "title": "Starting Billing Period Index"
    },
    "ending_billing_period_index": {
      "type": "integer",
      "title": "Ending Billing Period Index"
    },
    "offer_type": {
      "type": "string",
      "title": "Offer Type",
      "description": "Type of discount offer given, e.g. \"FREE_TRIAL\""
    },
    "offer_name": {
      "type": "string",
      "title": "Offer Name",
      "description": "Name of the discount offer given, e.g. \"introductory\""
    },
    "period_count": {
      "type": "integer",
      "title": "Period Count",
      "description": "Number of billing periods"
    },
    "period_length": {
      "type": "string",
      "title": "Period Length",
      "description": "Billing cycle length"
    },
    "amount": {
      "type": "string",
      "format": "decimal",
      "title": "Amount",
      "minimum": 0,
      "description": "Allows up to 9 decimal places"
    },
    "currency": {
      "type": "string",
      "title": "Currency",
      "description": "3-letter ISO 4217 currency code.",
      "maxLength": 3
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created at",
      "description": "When the external subscription was created in Recurly."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Updated at",
      "description": "When the external subscription was updated in Recurly."
    }
  }
}

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-payment-phase"
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.