Ghost · Schema

TierInput

Input fields for creating or updating a tier.

PublishingNewslettersMembershipsContentOpen Source

Properties

Name Type Description
name string Tier name
description string Tier description
active boolean Whether the tier is active
visibility string Public visibility
welcome_page_url string Welcome page URL
monthly_price integer Monthly price in smallest currency unit
yearly_price integer Yearly price in smallest currency unit
currency string ISO 4217 currency code
trial_days integer Number of free trial days
benefits array Tier benefits
View JSON Schema on GitHub

JSON Schema

ghost-tierinput-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TierInput",
  "title": "TierInput",
  "type": "object",
  "description": "Input fields for creating or updating a tier.",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Tier name"
    },
    "description": {
      "type": "string",
      "description": "Tier description",
      "nullable": true
    },
    "active": {
      "type": "boolean",
      "description": "Whether the tier is active"
    },
    "visibility": {
      "type": "string",
      "description": "Public visibility",
      "enum": [
        "public",
        "none"
      ]
    },
    "welcome_page_url": {
      "type": "string",
      "format": "uri",
      "description": "Welcome page URL",
      "nullable": true
    },
    "monthly_price": {
      "type": "integer",
      "description": "Monthly price in smallest currency unit",
      "minimum": 0
    },
    "yearly_price": {
      "type": "integer",
      "description": "Yearly price in smallest currency unit",
      "minimum": 0
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "pattern": "^[A-Z]{3}$"
    },
    "trial_days": {
      "type": "integer",
      "description": "Number of free trial days",
      "minimum": 0
    },
    "benefits": {
      "type": "array",
      "description": "Tier benefits",
      "items": {
        "type": "string"
      }
    }
  }
}