Upcoming Charge Collection

OpenAPI Schema

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

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "An upcoming ShootProof plan charge for a studio.",
        "properties": {
          "amount": {
            "description": "Upcoming plan list price (photo includes applicable promo). Account\ncredit is not subtracted here; it is exposed separately via money-balance.",
            "type": "number"
          },
          "billType": {
            "description": "The plan category for this charge.",
            "enum": [
              "photo",
              "music",
              "booking"
            ],
            "type": "string"
          },
          "currencyCode": {
            "description": "The ISO currency code for `amount`.",
            "type": "string"
          },
          "date": {
            "description": "The next bill date, formatted for display.",
            "type": "string"
          },
          "name": {
            "description": "Display name for the charge (e.g. Photo Plan).",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "upcoming-charge"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "billType",
          "name",
          "date",
          "amount",
          "currencyCode"
        ],
        "title": "Upcoming Charge",
        "type": "object"
      },
      "title": "Upcoming Charge",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "upcoming-charge-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection of upcoming charges",
  "type": "object"
}