Hippomundo Enterprise

Schema

object

A free allowance that currently applies to these requests. Present only while one applies. The listed number of successful requests in each window costs no credits; later ones cost the price shown. Free uses are counted for your whole account, and several operations can share one allowance. Your remaining free uses are not shown here.

Additional properties: false.

Field	Type	Description
`ends_at`	string (date-time)	When the allowance ends. Absent when no end is set.
`quantity`	integer (int64) · required	Number of free successful requests in each window. Minimum: `1`.
`text`	string · required	The allowance formatted for people, for example `5 free in any 24 hours`.
`window_kind`	string · required	`rolling`: any period of `window_seconds` ending now. `fixed_utc`: consecutive periods of `window_seconds`, aligned to UTC. Known values (open set): `["rolling","fixed_utc"]`.
`window_seconds`	integer (int64) · required	Length of the window in seconds. Minimum: `1`.

Complete OpenAPI definition

{
  "additionalProperties": false,
  "description": "A free allowance that currently applies to these requests. Present only while one applies. The listed number of successful requests in each window costs no credits; later ones cost the price shown. Free uses are counted for your whole account, and several operations can share one allowance. Your remaining free uses are not shown here.",
  "properties": {
    "ends_at": {
      "description": "When the allowance ends. Absent when no end is set.",
      "format": "date-time",
      "type": "string"
    },
    "quantity": {
      "description": "Number of free successful requests in each window.",
      "format": "int64",
      "minimum": 1,
      "type": "integer"
    },
    "text": {
      "description": "The allowance formatted for people, for example `5 free in any 24 hours`.",
      "type": "string"
    },
    "window_kind": {
      "description": "`rolling`: any period of `window_seconds` ending now. `fixed_utc`: consecutive periods of `window_seconds`, aligned to UTC.",
      "type": "string",
      "x-known-values": [
        "rolling",
        "fixed_utc"
      ]
    },
    "window_seconds": {
      "description": "Length of the window in seconds.",
      "format": "int64",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "quantity",
    "window_kind",
    "window_seconds",
    "text"
  ],
  "type": "object"
}

FreeAllowance

Schema