Studio Photo Plan

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A photo plan assigned to a studio.",
  "properties": {
    "allowUploads": {
      "description": "Whether photo uploads are allowed for this plan.",
      "type": "boolean"
    },
    "archiveRate": {
      "description": "Archiving cost per gigabyte.",
      "type": "number"
    },
    "band": {
      "description": "The plan band.",
      "nullable": true,
      "type": "number"
    },
    "currencyCode": {
      "description": "The type of currency used for this plan.",
      "type": "string"
    },
    "currencySymbol": {
      "description": "The currency symbol for the type of currency used for this plan.",
      "type": "string"
    },
    "description": {
      "description": "The plan description.",
      "type": "string"
    },
    "featureList": {
      "description": "The plan list of features.",
      "type": "array"
    },
    "featureListHeading": {
      "description": "The heading for the feature list.",
      "type": "string"
    },
    "freeArchiveStorageSpaceGranted": {
      "description": "Amount of free archive storage space granted, in bytes. Typically\ngranted via referral of another studio.\n\nThis value is `null` if the studio is in a `photo-storage` plan.",
      "nullable": true,
      "readOnly": true,
      "type": "number"
    },
    "freeArchiveStorageSpaceRemaining": {
      "description": "Amount of free archive storage space remaining, in bytes.\n\nThis value is `null` if the studio is in a `photo-storage` plan.",
      "nullable": true,
      "readOnly": true,
      "type": "number"
    },
    "id": {
      "description": "The encrypted id of the plan.",
      "type": "string"
    },
    "includesStudioManagement": {
      "description": "Whether the plan includes studio management features.",
      "type": "boolean"
    },
    "includesTave": {
      "description": "Whether the plan includes access to Tave.",
      "type": "boolean"
    },
    "isBlackFriday": {
      "description": "Whether the plan is a black friday deal.",
      "type": "boolean"
    },
    "isCountrySupported": {
      "description": "Whether the plan is supported in the studio's country.",
      "type": "boolean"
    },
    "isCurrent": {
      "description": "Whether the plan is the current studio's plan.",
      "type": "boolean"
    },
    "isFeatureGated": {
      "description": "Whether the plan is feature gated.",
      "type": "boolean"
    },
    "isFree": {
      "description": "Whether the plan is a *free* plan.",
      "type": "boolean"
    },
    "isInTrial": {
      "description": "Whether the plan is still in the trial period.",
      "type": "boolean"
    },
    "isMonthly": {
      "description": "Whether the plan renews on a monthly basis.",
      "type": "boolean"
    },
    "isStorageUsed": {
      "description": "Whether the plan is a storage-used gigabyte plan.",
      "type": "boolean"
    },
    "isUnlimited": {
      "description": "Whether the plan is an unlimited plan.",
      "type": "boolean"
    },
    "isYearly": {
      "description": "Whether the plan renews on a yearly basis.",
      "type": "boolean"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the plan.",
      "type": "string"
    },
    "photosAllowed": {
      "description": "The number of photos allowed for the plan.",
      "type": "number"
    },
    "planPeriod": {
      "description": "The type of billing period the plan falls under.",
      "enum": [
        "free",
        "monthly",
        "yearly"
      ],
      "type": "string"
    },
    "planType": {
      "description": "The type of subscription plan.",
      "enum": [
        "photo-count",
        "photo-storage"
      ],
      "type": "string"
    },
    "price": {
      "description": "The plan price.",
      "type": "number"
    },
    "promoPrice": {
      "description": "The plan promo price.",
      "nullable": true,
      "type": "number"
    },
    "totalActivePhotosCount": {
      "description": "The total active photos for stored for the studio.",
      "type": "number"
    },
    "totalActivePhotosStorage": {
      "description": "The total filesize (in bytes) of active photos stored for the\nstudio.",
      "type": "number"
    },
    "totalAllowedPhotos": {
      "description": "The total photos a studio can use at one time under this plan. This\ntakes into account the studio's plan total plus any bonuses they may\nhave.\n\nPlease note: If the `planType` is \"photo-storage,\" this value will\nbe `0`.",
      "type": "number"
    },
    "totalArchivedPhotosStorage": {
      "description": "Amount of archive storage space currently in use, in bytes.\n\nThis value is `null` if the studio is in a `photo-storage` plan.",
      "nullable": true,
      "readOnly": true,
      "type": "number"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "studio-photo-plan"
      ],
      "type": "string"
    },
    "uuid": {
      "description": "The plan UUID.",
      "type": "string"
    }
  },
  "readOnly": true,
  "title": "Studio Photo Plan",
  "type": "object"
}