Studio

Description

The studio.

Properties

Property Description
country

The country code for this studio.

created

The date on which this studio was created.

galleryUrl

The base URL for this studio's default brand.

hasExifSearch

Whether the studio has EXIF photo keyword searching enabled.

hasPaymentGateway

Whether the studio has a payment gateway set up.

isMusicPlanTrialEligible

Whether the studio is eligible for a Music Plan trial.

links required read-only

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.

musicPlan nullable read-only

A music plan assigned to a studio.

Property Description
currencyCode

The type of currency used for this plan.

currencySymbol

The currency symbol for the type of currency used for this plan.

description

The plan description.

isMonthly

Whether the plan renews on a monthly basis.

isUnlimited

Whether the plan is an unlimited plan.

isYearly

Whether the plan renews on a yearly basis.

links required read-only

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

The name of the plan.

playlistSize

The number of songs that can be added to a playlist.

price

The plan price.

type

The type of object represented.

photoPlan read-only

A photo plan assigned to a studio.

photosInQueueCount

The total number of photos in the queue to be processed for this studio.

type

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": "The studio.",
  "properties": {
    "country": {
      "description": "The country code for this studio.",
      "maxLength": 2,
      "minLength": 2,
      "type": "string"
    },
    "created": {
      "description": "The date on which this studio was created.",
      "format": "date-time",
      "type": "string"
    },
    "galleryUrl": {
      "description": "The base URL for this studio's default brand.",
      "format": "uri",
      "type": "string"
    },
    "hasExifSearch": {
      "description": "Whether the studio has EXIF photo keyword searching enabled.",
      "type": "boolean"
    },
    "hasPaymentGateway": {
      "description": "Whether the studio has a payment gateway set up.",
      "type": "boolean"
    },
    "isMusicPlanTrialEligible": {
      "description": "Whether the studio is eligible for a Music Plan trial.",
      "type": "boolean"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "musicPlan": {
      "description": "A music plan assigned to a studio.",
      "nullable": true,
      "properties": {
        "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"
        },
        "isMonthly": {
          "description": "Whether the plan renews on a monthly basis.",
          "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"
        },
        "playlistSize": {
          "description": "The number of songs that can be added to a playlist.",
          "enum": [
            3,
            20
          ],
          "type": "number"
        },
        "price": {
          "description": "The plan price.",
          "type": "number"
        },
        "type": {
          "description": "The type of object represented.",
          "enum": [
            "studio-music-plan"
          ],
          "type": "string"
        }
      },
      "readOnly": true,
      "title": "Studio Music Plan",
      "type": "object"
    },
    "photoPlan": {
      "$ref": "#/components/schemas/StudioPhotoPlan"
    },
    "photosInQueueCount": {
      "description": "The total number of photos in the queue to be processed for this\nstudio.",
      "type": "number"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "studio"
      ],
      "type": "string"
    }
  },
  "readOnly": true,
  "title": "Studio",
  "type": "object"
}