Studio

Description

The studio.

Properties

Property Description
country

The country code for this studio.

created

The date on which this studio was created.

emailRecipientsAllowed read-only

Studio users are allowed to send email through their ShootProof account for a variety of actions. Some of these allow the studio user to specify the email addresses of recipients. In these cases, this property indicates the maximum number of recipients the studio is allowed to add to a single email message. It is for information purposes only; ShootProof enforces this at the API, resulting in an appropriate error message if more than the allowed number of recipients are provided.

emailVerification

Information about email verification, if needed.

Property Description
challengeLink nullable

Absolute studio path for sending a verification email.

email nullable

Email that needs to be verified.

isVerified

Indicates whether email is verified or not.

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.

isFree

Whether the plan is a free plan.

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.

referral read-only

The referral property provides information regarding the number of other studios the current studio has referred, the credit the studio can earn, how much they've earned so far, and a URL the studio may use when referring others to ShootProof, so that they can get the referral credit when the others sign up for an account.

Property Description
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.

maxPossibleCredit

The maxPossibleCredit is the amount of credit this studio may earn per valid referral when this studio upgrades their plan.

This value is in the studio's plan currency. To get the currency symbol and code, use the me resource and find these values at .studio.photoPlan.currencySymbol and .studio.photoPlan.currencyCode.

planPossibleCredit

Based on this studio's current plan, the planPossibleCredit is the amount of credit a studio may earn when a referred studio's first bill is processed.

This value is in the studio's plan currency. To get the currency symbol and code, use the me resource and find these values at .studio.photoPlan.currencySymbol and .studio.photoPlan.currencyCode.

referralsJoined

The number of studios who have signed up through the current studio's referral URL and who have processed their first bill.

totalCreditEarned

The total amount of credit the studio has earned from referrals.

This value is in the studio's plan currency. To get the currency symbol and code, use the me resource and find these values at .studio.photoPlan.currencySymbol and .studio.photoPlan.currencyCode.

type

The type of resource represented.

url

A URL the studio may give to others in order to get referral credit when the others sign up for a ShootProof account.

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"
    },
    "emailRecipientsAllowed": {
      "description": "Studio users are allowed to send email through their ShootProof account\nfor a variety of actions. Some of these allow the studio user to specify\nthe email addresses of recipients. In these cases, this property indicates\nthe maximum number of recipients the studio is allowed to add to a single\nemail message. It is for information purposes only; ShootProof enforces\nthis at the API, resulting in an appropriate error message if more than\nthe allowed number of recipients are provided.",
      "readOnly": true,
      "type": "integer"
    },
    "emailVerification": {
      "description": "Information about email verification, if needed.",
      "properties": {
        "challengeLink": {
          "description": "Absolute studio path for sending a verification email.",
          "nullable": true,
          "type": "string"
        },
        "email": {
          "description": "Email that needs to be verified.",
          "nullable": true,
          "type": "string"
        },
        "isVerified": {
          "description": "Indicates whether email is verified or not.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "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"
        },
        "isFree": {
          "description": "Whether the plan is a *free* plan.",
          "type": "boolean"
        },
        "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"
    },
    "referral": {
      "description": "The referral property provides information regarding the number of other\nstudios the current studio has referred, the credit the studio can earn,\nhow much they've earned so far, and a URL the studio may use when\nreferring others to ShootProof, so that they can get the referral credit\nwhen the others sign up for an account.",
      "properties": {
        "links": {
          "$ref": "#/components/schemas/Links"
        },
        "maxPossibleCredit": {
          "description": "The `maxPossibleCredit` is the amount of credit this studio may earn\nper valid referral when this studio upgrades their plan.\n\nThis value is in the studio's plan currency. To get the currency symbol\nand code, use the `me` resource and find these values at\n`.studio.photoPlan.currencySymbol` and `.studio.photoPlan.currencyCode`.",
          "type": "number"
        },
        "planPossibleCredit": {
          "description": "Based on this studio's current plan, the `planPossibleCredit` is the\namount of credit a studio may earn when a referred studio's first\nbill is processed.\n\nThis value is in the studio's plan currency. To get the currency symbol\nand code, use the `me` resource and find these values at\n`.studio.photoPlan.currencySymbol` and `.studio.photoPlan.currencyCode`.",
          "type": "number"
        },
        "referralsJoined": {
          "description": "The number of studios who have signed up through the current studio's\nreferral URL and who have processed their first bill.",
          "type": "integer"
        },
        "totalCreditEarned": {
          "description": "The total amount of credit the studio has earned from referrals.\n\nThis value is in the studio's plan currency. To get the currency symbol\nand code, use the `me` resource and find these values at\n`.studio.photoPlan.currencySymbol` and `.studio.photoPlan.currencyCode`.",
          "type": "number"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Type"
            },
            {
              "enum": [
                "studio-referral"
              ]
            }
          ]
        },
        "url": {
          "description": "A URL the studio may give to others in order to get referral credit\nwhen the others sign up for a ShootProof account.",
          "format": "uri",
          "type": "string"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "studio"
      ],
      "type": "string"
    }
  },
  "readOnly": true,
  "title": "Studio",
  "type": "object"
}