Recurly · Schema

ExternalInvoiceCreate

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
external_id string An identifier which associates the external invoice to a corresponding object in an external platform.
state object
total string
currency string 3-letter ISO 4217 currency code.
purchased_at string When the invoice was created in the external platform.
line_items array
external_payment_phase object
external_payment_phase_id string External payment phase ID, e.g. `a34ypb2ef9w1`.
View JSON Schema on GitHub

JSON Schema

recurly-external-invoice-create-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-external-invoice-create-schema.json",
  "title": "ExternalInvoiceCreate",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-external-invoice-api-openapi.yml#/components/schemas/ExternalInvoiceCreate",
  "type": "object",
  "properties": {
    "external_id": {
      "type": "string",
      "description": "An identifier which associates the external invoice to a corresponding object in an external platform."
    },
    "state": {
      "$ref": "#/$defs/ExternalInvoiceStateEnum"
    },
    "total": {
      "type": "string",
      "format": "decimal"
    },
    "currency": {
      "type": "string",
      "title": "Currency",
      "description": "3-letter ISO 4217 currency code.",
      "maxLength": 3
    },
    "purchased_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the invoice was created in the external platform."
    },
    "line_items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ExternalChargeCreate"
      }
    },
    "external_payment_phase": {
      "$ref": "#/$defs/ExternalPaymentPhaseBase"
    },
    "external_payment_phase_id": {
      "type": "string",
      "description": "External payment phase ID, e.g. `a34ypb2ef9w1`."
    }
  },
  "required": [
    "external_id",
    "state",
    "total",
    "currency",
    "purchased_at"
  ],
  "$defs": {
    "ExternalChargeCreate": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "title": "Currency",
          "description": "3-letter ISO 4217 currency code.",
          "maxLength": 3
        },
        "unit_amount": {
          "type": "string",
          "format": "decimal"
        },
        "quantity": {
          "type": "integer"
        },
        "description": {
          "type": "string"
        },
        "external_product_reference": {
          "$ref": "#/$defs/ExternalProductReferenceCreate"
        }
      },
      "required": [
        "quantity",
        "currency",
        "unit_amount"
      ]
    },
    "ExternalInvoiceStateEnum": {
      "type": "string",
      "enum": [
        "paid"
      ]
    },
    "ExternalPaymentPhaseBase": {
      "type": "object",
      "properties": {
        "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
        }
      }
    },
    "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"
    },
    "ExternalProductReferenceCreate": {
      "allOf": [
        {
          "$ref": "#/$defs/ExternalProductReferenceBase"
        }
      ],
      "required": [
        "reference_code",
        "external_connection_type"
      ]
    }
  }
}

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-invoice-create"
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.