Hippomundo Enterprise API
Schemas

FilteredOperation

Response and request schema

Schema

object

One available operation, as in the published reference, plus its current price in x-credits.

Additional properties: true.

FieldTypeDescription
x-creditsOperationCredits

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.

Related schemas: OperationCredits

Complete OpenAPI definition
{
  "additionalProperties": true,
  "description": "One available operation, as in the published reference, plus its current price in `x-credits`.",
  "properties": {
    "x-credits": {
      "$ref": "#/components/schemas/OperationCredits"
    }
  },
  "type": "object"
}