Hippomundo Enterprise

Schema

object

The operation's price under the current price list, read when the document is requested. The price is the same for every customer. It applies to each successful response; for an operation that accepts page_token it applies to each first page, sent without page_token, including an empty page. Errors are never charged. Operations that do not accept Idempotency-Key are always free and show 0. milli_credits uses the same unit as your account balance; one credit is 1,000 milli-credits.

Additional properties: false.

Field	Type	Description
`credits_text`	string · required	The same price in credits, formatted for people, for example `370 credits` or `88.5 credits`.
`follow_on_page`	PagePrice	Price of each follow-on page, sent with `page_token`, including an empty page. Present only for operations that accept `page_token`. Additional properties: `false`.
`free_allowance`	FreeAllowance	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`.
`milli_credits`	integer (int64) · required	Price in milli-credits. Minimum: `0`.

Related schemas: PagePrice, FreeAllowance

Complete OpenAPI definition

{
  "additionalProperties": false,
  "description": "The operation's price under the current price list, read when the document is requested. The price is the same for every customer. It applies to each successful response; for an operation that accepts `page_token` it applies to each first page, sent without `page_token`, including an empty page. Errors are never charged. Operations that do not accept `Idempotency-Key` are always free and show 0. `milli_credits` uses the same unit as your account balance; one credit is 1,000 milli-credits.",
  "example": {
    "credits_text": "370 credits",
    "follow_on_page": {
      "credits_text": "370 credits",
      "milli_credits": 370000
    },
    "milli_credits": 370000
  },
  "properties": {
    "credits_text": {
      "description": "The same price in credits, formatted for people, for example `370 credits` or `88.5 credits`.",
      "type": "string"
    },
    "follow_on_page": {
      "$ref": "#/components/schemas/PagePrice"
    },
    "free_allowance": {
      "$ref": "#/components/schemas/FreeAllowance"
    },
    "milli_credits": {
      "description": "Price in milli-credits.",
      "format": "int64",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "milli_credits",
    "credits_text"
  ],
  "type": "object"
}

OperationCredits

Schema