← Back to schema index

GetUsageBreakdownAttributes

Attributes of the resource returned when querying the current period's usage breakdown by operation type (validations, OCR, etc.).

Properties

FieldTypeDescription
dataobjectResponse body. Everything hangs off here, per the JSON:API envelope.
typestringResource type, fixed for this operation. Part of the resource identity in the JSON:API envelope.
attributesobjectThe resource's own data, kept apart from its identity.
periodstringMonth the breakdown belongs to.
operationsarrayOne entry per operation type, with what each consumed.

Used in operations

  • GET /v1/usage/breakdown