Studio Photo Plan : Studio API : Reference : ShootProof for Developers

Description

studio-photo-plan

Studio Photo Plan

A photo plan assigned to a studio.

Properties

Property	Description
allowUploads	`boolean` Whether photo uploads are allowed for this plan.
archiveRate	`number` Archiving cost per gigabyte.
currencyCode	`string` The type of currency used for this plan.
currencySymbol	`string` The currency symbol for the type of currency used for this plan.
description	`string` The plan description.
freeArchiveStorageSpaceGranted nullable read-only	`number` Amount of free archive storage space granted, in bytes. Typically granted via referral of another studio. This value is `null` if the studio is in a `photo-storage` plan.
freeArchiveStorageSpaceRemaining nullable read-only	`number` Amount of free archive storage space remaining, in bytes. This value is `null` if the studio is in a `photo-storage` plan.
includesStudioManagement	`boolean` Whether the plan includes studio management features.
isFree	`boolean` Whether the plan is a free plan.
isMonthly	`boolean` Whether the plan renews on a monthly basis.
isStorageUsed	`boolean` Whether the plan is a storage-used gigabyte plan.
isUnlimited	`boolean` Whether the plan is an unlimited plan.
isYearly	`boolean` Whether the plan renews on a yearly basis.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the plan.
planType	`string` enum photo-count photo-storage The type of subscription plan.
price	`number` The plan price.
totalActivePhotosCount	`number` The total active photos for stored for the studio.
totalActivePhotosStorage	`number` The total filesize (in bytes) of active photos stored for the studio.
totalAllowedPhotos	`number` The total photos a studio can use at one time under this plan. This takes into account the studio's plan total plus any bonuses they may have. Please note: If the `planType` is "photo-storage," this value will be `0`.
totalArchivedPhotosStorage nullable read-only	`number` Amount of archive storage space currently in use, in bytes. This value is `null` if the studio is in a `photo-storage` plan.
type	`string` enum studio-photo-plan The type of object represented.

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"
    },
    "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"
    },
    "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"
    },
    "includesStudioManagement": {
      "description": "Whether the plan includes studio management features.",
      "type": "boolean"
    },
    "isFree": {
      "description": "Whether the plan is a *free* plan.",
      "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"
    },
    "planType": {
      "description": "The type of subscription plan.",
      "enum": [
        "photo-count",
        "photo-storage"
      ],
      "type": "string"
    },
    "price": {
      "description": "The plan price.",
      "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"
    }
  },
  "readOnly": true,
  "title": "Studio Photo Plan",
  "type": "object"
}

Studio Photo Plan