Recurly · Schema

SubscriptionCreateRequestDTO

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
deliveryCadenceCount number
deliveryCadenceUnit string
billingCadenceCount number
billingCadenceUnit string
customAttributes array
subscriberId string
subscriptionOfferId string The internal id of the subscription plan (subscription offer) this subscription belongs to. Every line must belong to this plan.
deliveryFirstName string Required unless the subscription plan is digital-only (no shipping needed).
deliveryLastName string Required unless the subscription plan is digital-only (no shipping needed).
deliveryAddress1 string Required unless the subscription plan is digital-only (no shipping needed).
deliveryAddress2 stringnull
deliveryCountry string Required unless the subscription plan is digital-only (no shipping needed).
deliveryCountryCode string
deliveryProvince stringnull
deliveryProvinceCode string
deliveryCity string Required unless the subscription plan is digital-only (no shipping needed).
deliveryZip string Required unless the subscription plan is digital-only (no shipping needed).
deliveryPhone string The delivery phone number. Required unless the subscription plan is digital-only.
deliveryCompany stringnull
paymentMethodExternalId string The shopify payment method ID
lines array
discountCode stringnull
View JSON Schema on GitHub

JSON Schema

recurly-subscription-create-request-dto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-subscription-create-request-dto-schema.json",
  "title": "SubscriptionCreateRequestDTO",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-commerce-openapi.yml#/components/schemas/SubscriptionCreateRequestDTO",
  "type": "object",
  "properties": {
    "deliveryCadenceCount": {
      "type": "number"
    },
    "deliveryCadenceUnit": {
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "MONTH",
        "WEEK",
        "YEAR"
      ]
    },
    "billingCadenceCount": {
      "type": "number"
    },
    "billingCadenceUnit": {
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "MONTH",
        "WEEK",
        "YEAR"
      ]
    },
    "customAttributes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CustomAttribute"
      }
    },
    "subscriberId": {
      "type": "string"
    },
    "subscriptionOfferId": {
      "type": "string",
      "description": "The internal id of the subscription plan (subscription offer) this subscription belongs to. Every line must belong to this plan."
    },
    "deliveryFirstName": {
      "type": "string",
      "description": "Required unless the subscription plan is digital-only (no shipping needed)."
    },
    "deliveryLastName": {
      "type": "string",
      "description": "Required unless the subscription plan is digital-only (no shipping needed)."
    },
    "deliveryAddress1": {
      "type": "string",
      "description": "Required unless the subscription plan is digital-only (no shipping needed)."
    },
    "deliveryAddress2": {
      "type": [
        "string",
        "null"
      ]
    },
    "deliveryCountry": {
      "type": "string",
      "description": "Required unless the subscription plan is digital-only (no shipping needed)."
    },
    "deliveryCountryCode": {
      "type": "string"
    },
    "deliveryProvince": {
      "type": [
        "string",
        "null"
      ]
    },
    "deliveryProvinceCode": {
      "type": "string"
    },
    "deliveryCity": {
      "type": "string",
      "description": "Required unless the subscription plan is digital-only (no shipping needed)."
    },
    "deliveryZip": {
      "type": "string",
      "description": "Required unless the subscription plan is digital-only (no shipping needed)."
    },
    "deliveryPhone": {
      "type": "string",
      "description": "The delivery phone number. Required unless the subscription plan is digital-only."
    },
    "deliveryCompany": {
      "type": [
        "string",
        "null"
      ]
    },
    "paymentMethodExternalId": {
      "type": "string",
      "description": "The shopify payment method ID"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SubscriptionLineCreateThroughContractRequestDto"
      }
    },
    "discountCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "deliveryCadenceCount",
    "deliveryCadenceUnit",
    "billingCadenceCount",
    "billingCadenceUnit",
    "subscriberId",
    "subscriptionOfferId",
    "paymentMethodExternalId",
    "lines"
  ],
  "$defs": {
    "CustomAttribute": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "key",
        "value"
      ]
    },
    "SubscriptionLineCreateThroughContractRequestDto": {
      "type": "object",
      "properties": {
        "variantId": {
          "type": "string"
        },
        "quantity": {
          "type": "number"
        },
        "currentPrice": {
          "type": "number",
          "description": "The price of the variant before the subscription discount. Only use if you want to override the default price of the variant."
        },
        "sellingPlanId": {
          "type": "string",
          "description": "The shopify selling plan ID of the subscription offer option. The configured discount will be used to calculated the amount of the line."
        },
        "customAttributes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CustomAttribute"
          }
        }
      },
      "required": [
        "variantId",
        "quantity",
        "sellingPlanId"
      ]
    }
  }
}

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-subscription-create-request-dto"
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.