get_plans_id

{
  "type": "object",
  "required": [
    "alias",
    "benefits",
    "billingPeriodFrequency",
    "billingPeriodType",
    "currency",
    "hasTrialPeriod",
    "id",
    "isActive",
    "isFeatured",
    "isPrivate",
    "revenueType",
    "subscriptionCode",
    "tagline",
    "termsAndConditions",
    "title",
    "trialPeriodDays",
    "type"
  ],
  "properties": {
    "alias": {
      "type": "string",
      "description": "An alias for a plan."
    },
    "benefits": {
      "type": "array",
      "description": "The list of benefits to display for a plan.",
      "items": {
        "type": "string"
      }
    },
    "billingPeriodFrequency": {
      "type": "integer",
      "format": "int32",
      "description": "Given the `billingPeriodType` this is how frequently it will run. e.g. every 2 weeks."
    },
    "billingPeriodType": {
      "type": "string",
      "description": "The type of billing period used.",
      "enum": [
        "day",
        "week",
        "month",
        "year",
        "none"
      ]
    },
    "currency": {
      "type": "string",
      "description": "The currency a plan is offered in."
    },
    "customFields": {
      "type": "object",
      "description": "A map of custom fields defined by a curator for a plan."
    },
    "hasTrialPeriod": {
      "type": "boolean",
      "description": "True if a plan has a trial period, false if not."
    },
    "id": {
      "type": "string",
      "description": "The identifier of a plan."
    },
    "isActive": {
      "type": "boolean",
      "description": "True if a plan is active, false if its retired."
    },
    "isFeatured": {
      "type": "boolean",
      "description": "True if a plan should be highlighted as featured, false if not."
    },
    "isPrivate": {
      "type": "boolean",
      "description": "True if a plan should not be presented in the primary plan options, false if not."
    },
    "price": {
      "type": "number",
      "format": "float",
      "description": "The price of a plan. If a free plan then undefined."
    },
    "revenueType": {
      "type": "string",
      "description": "The revenue type a plan targets.",
      "enum": [
        "TVOD",
        "SVOD"
      ]
    },
    "subscriptionCode": {
      "type": "string",
      "description": "The subscription code a plan targets."
    },
    "tagline": {
      "type": "string",
      "description": "The short tagline for a plan."
    },
    "termsAndConditions": {
      "type": "string",
      "description": "The terms and conditions for a plan."
    },
    "title": {
      "type": "string",
      "description": "The title of a plan."
    },
    "trialPeriodDays": {
      "type": "integer",
      "format": "int32",
      "description": "How many days a trial period runs for a plan. Only valid if `hasTrialPeriod` is true."
    },
    "type": {
      "type": "string",
      "description": "The type of plan.",
      "enum": [
        "Free",
        "Subscription"
      ]
    }
  },
  "additionalProperties": false
}