Event Archive Cost

Description

An event's archive cost.

Properties

Property Description
archiveRate read-only

Archiving cost per gigabyte.

billingDay read-only

Day of the calendar month on which archiving costs will be included on a bill.

For example:

  • Value is 1 for studios in a yearly photo plan; archiving costs are billed for on the 1st of every calendar month.
  • Value is X for studios in a monthly photo plan, where X is the calendar day of when their photo plan is billed. Monthly photo plan bills include archiving costs alongside their monthly photo plan costs.
currencyCode read-only

Currency code that applies to the given archiveRate, eventTotalCost and minimumCharge values.

currentArchiveStorageSpaceUsed nullable read-only

Amount of archive storage space currently in use, in bytes.

This value is null if the studio is in a photo-storage plan.

eventTotalCost read-only

Total monthly cost to archive this event in given currencyCode.

eventTotalSize read-only

Total size of archive storage space, that event will use, in bytes.

eventWillIncurCost read-only

Indicates that choosing to archive this event will incur a cost on next billing date.

freeArchiveStorageSpaceGranted nullable read-only

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

Amount of free archive storage space remaining, in bytes.

This value is null if the studio is in a photo-storage plan.

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.

minimumCharge read-only

Minimum monthly charge amount for archiving in given currencyCode. Studio will pay this amount monthly when archiving up to minimumChargeNumBytes worth of photos.

minimumChargeNumBytes read-only

The amount of archive storage space, that can be used until the minimum charge is exceeded, in bytes.

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": "An event's archive cost.",
  "properties": {
    "archiveRate": {
      "description": "Archiving cost per gigabyte.",
      "readOnly": true,
      "type": "number"
    },
    "billingDay": {
      "description": "Day of the calendar month on which archiving costs will be included\non a bill.\n\nFor example:\n\n* Value is `1` for studios in a yearly photo plan; archiving costs\nare billed for on the 1st of every calendar month.\n* Value is `X` for studios in a monthly photo plan, where `X` is the\ncalendar day of when their photo plan is billed.  Monthly photo plan\nbills include archiving costs alongside their monthly photo plan\ncosts.",
      "readOnly": true,
      "type": "number"
    },
    "currencyCode": {
      "description": "Currency code that applies to the given `archiveRate`,\n`eventTotalCost` and `minimumCharge` values.",
      "readOnly": true,
      "type": "string"
    },
    "currentArchiveStorageSpaceUsed": {
      "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"
    },
    "eventTotalCost": {
      "description": "Total monthly cost to archive this event in given `currencyCode`.",
      "minimum": 0,
      "readOnly": true,
      "type": "number"
    },
    "eventTotalSize": {
      "description": "Total size of archive storage space, that event will use, in bytes.",
      "readOnly": true,
      "type": "number"
    },
    "eventWillIncurCost": {
      "description": "Indicates that choosing to archive this event will incur a cost on\nnext billing date.",
      "readOnly": true,
      "type": "boolean"
    },
    "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"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "minimumCharge": {
      "description": "Minimum monthly charge amount for archiving in given `currencyCode`.\nStudio will pay this amount monthly when archiving up to\n`minimumChargeNumBytes` worth of photos.",
      "minimum": 0,
      "readOnly": true,
      "type": "number"
    },
    "minimumChargeNumBytes": {
      "description": "The amount of archive storage space, that can be used until the\nminimum charge is exceeded, in bytes.",
      "minimum": 0,
      "readOnly": true,
      "type": "number"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "event-archive-cost"
      ],
      "type": "string"
    }
  },
  "title": "Event Archive Cost",
  "type": "object"
}