Recurly · Schema

PlanRequest

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook
View JSON Schema on GitHub

JSON Schema

recurly-plan-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-plan-request-schema.json",
  "title": "PlanRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-plans-api-openapi.yml#/components/schemas/PlanRequest",
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/$defs/PlanFixedPricingRequest"
    },
    {
      "$ref": "#/$defs/PlanRampPricingRequest"
    }
  ],
  "$defs": {
    "Currencies": {
      "type": "array",
      "description": "Array of currency objects, see example below. Max 10000000.",
      "items": {
        "type": "object"
      },
      "maxItems": 10000000
    },
    "CustomField": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 50,
          "pattern": "/^[a-z0-9_-]+$/i",
          "title": "Field name",
          "description": "Fields must be created in the UI before values can be assigned to them."
        },
        "value": {
          "type": "string",
          "maxLength": 255,
          "title": "Field value",
          "description": "Any values that resemble a credit card number or security code (CVV/CVC) will be rejected."
        }
      }
    },
    "CustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CustomField"
      },
      "title": "Custom Fields",
      "description": "The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value."
    },
    "GeneralLedgerAccountId": {
      "type": "string",
      "title": "General Ledger Account ID",
      "description": "The ID of a general ledger account. General ledger accounts are\nonly accessible as a part of the Recurly RevRec Standard and\nRecurly RevRec Advanced features.\n",
      "maxLength": 13
    },
    "PerformanceObligationId": {
      "type": "string",
      "title": "Performance Obligation ID",
      "description": "The ID of a performance obligation. Performance obligations are\nonly accessible as a part of the Recurly RevRec Standard and\nRecurly RevRec Advanced features.\n",
      "maxLength": 13
    },
    "PlanBase": {
      "allOf": [
        {
          "$ref": "#/$defs/PlanUpdateBase"
        },
        {
          "type": "object",
          "properties": {
            "plan_interval_unit": {
              "type": "string",
              "default": "months",
              "description": "`days`, or `months`, defaults to `months`."
            },
            "plan_interval_length": {
              "type": "integer",
              "default": "1",
              "description": "Plan interval length, defaults to `1`"
            }
          }
        }
      ]
    },
    "PlanCode": {
      "type": "string",
      "default": "",
      "maxLength": 50,
      "description": "Unique code to identify the plan. This code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 50 characters."
    },
    "PlanFixedPricing": {
      "allOf": [
        {
          "$ref": "#/$defs/PlanMini"
        },
        {
          "$ref": "#/$defs/PlanFixedPricingProperties"
        },
        {
          "$ref": "#/$defs/PlanBase"
        }
      ]
    },
    "PlanFixedPricingProperties": {
      "type": "object",
      "properties": {
        "unit_amount_in_cents": {
          "$ref": "#/$defs/Currencies"
        },
        "pricing_model": {
          "$ref": "#/$defs/PricingModelTypeEnum"
        }
      }
    },
    "PlanFixedPricingRequest": {
      "allOf": [
        {
          "$ref": "#/$defs/PlanFixedPricing"
        },
        {
          "required": [
            "plan_code",
            "name",
            "unit_amount_in_cents"
          ]
        }
      ]
    },
    "PlanMini": {
      "type": "object",
      "properties": {
        "plan_code": {
          "$ref": "#/$defs/PlanCode"
        },
        "name": {
          "type": "string",
          "default": "",
          "maxLength": 255,
          "description": "Plan name. Max of 255 characters."
        }
      }
    },
    "PlanRampInterval": {
      "type": "object",
      "title": "Plan Ramp Interval",
      "properties": {
        "starting_billing_cycle": {
          "$ref": "#/$defs/RampIntervalStartingBillingCycle"
        },
        "unit_amount_in_cents": {
          "$ref": "#/$defs/Currencies"
        }
      }
    },
    "PlanRampPricing": {
      "allOf": [
        {
          "$ref": "#/$defs/PlanMini"
        },
        {
          "$ref": "#/$defs/PlanRampPricingProperties"
        },
        {
          "$ref": "#/$defs/PlanBase"
        }
      ]
    },
    "PlanRampPricingProperties": {
      "type": "object",
      "properties": {
        "ramp_intervals": {
          "type": "array",
          "minItems": 1,
          "maxItems": 12,
          "items": {
            "$ref": "#/$defs/PlanRampInterval"
          }
        },
        "pricing_model": {
          "$ref": "#/$defs/PricingModelTypeEnum"
        }
      }
    },
    "PlanRampPricingRequest": {
      "allOf": [
        {
          "$ref": "#/$defs/PlanRampPricing"
        },
        {
          "required": [
            "plan_code",
            "name",
            "ramp_intervals"
          ]
        }
      ]
    },
    "PlanUpdateBase": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "default": "",
          "description": "Optional plan description, not displayed."
        },
        "trial_interval_unit": {
          "type": "string",
          "default": "days",
          "description": "`days` or `months`, defaults to `days`."
        },
        "trial_interval_length": {
          "type": "integer",
          "default": "0",
          "description": "Defaults to `0`, for no trial"
        },
        "trial_requires_billing_info": {
          "type": "boolean",
          "default": "",
          "description": "Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee."
        },
        "success_url": {
          "type": "string",
          "default": "",
          "description": "URL to redirect to after signup on the hosted payment pages."
        },
        "accounting_code": {
          "type": "string",
          "default": "",
          "description": "Accounting code for related invoice line items, code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 20 characters."
        },
        "revenue_schedule_type": {
          "type": "string",
          "default": "evenly",
          "description": "Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan should be recognized. When creating a Plan, available schedule types are `never`, `evenly`, `at_range_start`, or `at_range_end`."
        },
        "liability_gl_account_id": {
          "$ref": "#/$defs/GeneralLedgerAccountId"
        },
        "revenue_gl_account_id": {
          "$ref": "#/$defs/GeneralLedgerAccountId"
        },
        "performance_obligation_id": {
          "$ref": "#/$defs/PerformanceObligationId"
        },
        "setup_fee_accounting_code": {
          "type": "string",
          "default": "",
          "description": "Accounting code for a Setup Fee, code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 20 characters."
        },
        "setup_fee_revenue_schedule_type": {
          "type": "string",
          "default": "evenly",
          "description": "Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan Setup Fee should be recognized. When creating a Plan Setup Fee, available schedule types are `never`, `evenly`, `at_range_start`, or `at_range_end`."
        },
        "setup_fee_liability_gl_account_id": {
          "$ref": "#/$defs/GeneralLedgerAccountId"
        },
        "setup_fee_revenue_gl_account_id": {
          "$ref": "#/$defs/GeneralLedgerAccountId"
        },
        "setup_fee_performance_obligation_id": {
          "$ref": "#/$defs/PerformanceObligationId"
        },
        "setup_fee_in_cents": {
          "$ref": "#/$defs/Currencies"
        },
        "total_billing_cycles": {
          "type": "integer",
          "default": "",
          "description": "Number of billing cycles before the plan stops renewing, defaults to `null` for continuous auto renewal."
        },
        "unit_name": {
          "type": "string",
          "default": "",
          "description": "*Deprecated* Unit description for the quantity, e.g. users."
        },
        "display_quantity": {
          "type": "boolean",
          "default": "false",
          "description": "Display the quantity field on the hosted payment page if `true`, defaults to `false`."
        },
        "cancel_url": {
          "type": "string",
          "default": "",
          "description": "*Deprecated* URL to redirect to on canceled signup on the hosted payment pages."
        },
        "tax_exempt": {
          "type": "boolean",
          "default": "",
          "description": "`true` exempts tax on the plan, `false` applies tax on the plan. If not defined, then defaults to the Plan and Site settings."
        },
        "tax_code": {
          "type": "string",
          "maxLength": 50,
          "title": "Tax code",
          "description": "Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes."
        },
        "auto_renew": {
          "type": "boolean",
          "default": true,
          "description": "Determines whether subscriptions to this plan should auto-renew term at the end of the current term or expire."
        },
        "bypass_hosted_confirmation": {
          "type": "boolean",
          "default": "",
          "description": "If `true`, the customer will be sent directly to your `success_url` after a successful signup, bypassing Recurly's hosted confirmation page."
        },
        "allow_any_item_on_subscriptions": {
          "type": "boolean",
          "default": false,
          "description": "Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used."
        },
        "vertex_transaction_type": {
          "type": "string",
          "default": "sale",
          "description": "Used by Vertex for tax calculations. Possible values are `sale`, `rental`, `lease`."
        },
        "dunning_campaign_id": {
          "type": "string",
          "default": "",
          "description": "Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used."
        },
        "custom_fields": {
          "$ref": "#/$defs/CustomFields"
        }
      }
    },
    "PricingModelTypeEnum": {
      "type": "string",
      "title": "Pricing Model",
      "enum": [
        "fixed",
        "ramp"
      ],
      "default": "fixed",
      "description": "A fixed pricing model has the same price (i.e. `unit_amount_in_cents`)\nfor each billing period. A ramp pricing model instead defines a set of\nramp intervals (i.e. `ramp_intervals`), where a subscription changes\nprice on a specified cadence of billing periods. The price change could\nbe an increase or decrease. Ramp pricing is only available on Recurly\nPro and Elite plans, as well as sandbox sites.\n"
    },
    "RampIntervalStartingBillingCycle": {
      "type": "integer",
      "description": "Represents the billing cycle where a ramp interval starts.",
      "minimum": 1,
      "default": 1
    }
  }
}

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-plan-request"
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.