Ghost · Schema

OfferInput

Input fields for creating or updating an offer.

PublishingNewslettersMembershipsSubscriptionCMSOpen-SourceContent

Properties

Name Type Description
name string Internal name
code string URL-safe code
display_title string Public-facing title
display_description string Public-facing description
type string Discount type
cadence string Billing cadence
amount integer Discount amount
duration string Discount duration
duration_in_months integer Months for repeating duration
currency string Currency code for fixed discounts
status string Offer status
tier object Tier to apply the offer to
View JSON Schema on GitHub

JSON Schema

ghost-org-offerinput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OfferInput",
  "title": "OfferInput",
  "type": "object",
  "description": "Input fields for creating or updating an offer.",
  "required": [
    "name",
    "code",
    "display_title",
    "type",
    "cadence",
    "amount",
    "duration",
    "tier"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Internal name"
    },
    "code": {
      "type": "string",
      "description": "URL-safe code"
    },
    "display_title": {
      "type": "string",
      "description": "Public-facing title"
    },
    "display_description": {
      "type": "string",
      "description": "Public-facing description",
      "nullable": true
    },
    "type": {
      "type": "string",
      "enum": [
        "percent",
        "fixed",
        "trial"
      ],
      "description": "Discount type"
    },
    "cadence": {
      "type": "string",
      "enum": [
        "month",
        "year"
      ],
      "description": "Billing cadence"
    },
    "amount": {
      "type": "integer",
      "description": "Discount amount",
      "minimum": 0
    },
    "duration": {
      "type": "string",
      "enum": [
        "once",
        "repeating",
        "forever",
        "trial"
      ],
      "description": "Discount duration"
    },
    "duration_in_months": {
      "type": "integer",
      "description": "Months for repeating duration",
      "nullable": true,
      "minimum": 1
    },
    "currency": {
      "type": "string",
      "description": "Currency code for fixed discounts",
      "nullable": true,
      "pattern": "^[A-Z]{3}$"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "archived"
      ],
      "description": "Offer status"
    },
    "tier": {
      "type": "object",
      "description": "Tier to apply the offer to",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Tier identifier"
        }
      }
    }
  }
}

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/ghost-org-offerinput"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.