> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt > Use this file to discover all available pages before exploring further. # List a customer's agent consumption > The customer's consumption ledger, newest first: one entry per consume call, priced by the server. `overage: true` entries were charged past the credit or allowance boundary and settle through the configured wallet or invoice. Filter with `agent`, `overage`, `from`/`to` (ISO instants); paginated with take/skip. ## OpenAPI ````yaml get /v1/ai/billing/customers/{customer_id}/consumption openapi: 3.1.0 info: title: Hyperline API version: 0.0.0 servers: - url: https://api.hyperline.co - url: https://sandbox.api.hyperline.co security: [] paths: /v1/ai/billing/customers/{customer_id}/consumption: get: tags: - AI > Billing summary: List a customer's agent consumption description: >- The customer's consumption ledger, newest first: one entry per consume call, priced by the server. `overage: true` entries were charged past the credit or allowance boundary and settle through the configured wallet or invoice. Filter with `agent`, `overage`, `from`/`to` (ISO instants); paginated with take/skip. operationId: listAgentCustomerConsumption parameters: - schema: type: string required: true name: customer_id in: path - schema: type: string maxLength: 128 description: >- Agent slug. An empty string selects the shared pool; omission includes all scopes. example: support required: false description: >- Agent slug. An empty string selects the shared pool; omission includes all scopes. name: agent in: query - schema: anyOf: - type: boolean - type: string enum: - 'true' - 'false' description: >- Filter by overage status. Omit to include both ordinary and overage entries. example: false required: false description: >- Filter by overage status. Omit to include both ordinary and overage entries. name: overage in: query - schema: type: string format: date-time description: >- UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. example: '2024-12-20T16:04:11Z' required: false description: >- UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. name: from in: query - schema: type: string format: date-time description: >- UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. example: '2024-12-20T16:04:11Z' required: false description: >- UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. name: to in: query - schema: type: - number - 'null' minimum: 0 maximum: 100 default: 50 required: false name: take in: query - schema: type: - number - 'null' minimum: 0 default: 0 required: false name: skip in: query responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedAgentConsumptionEntry' '400': description: Invalid request. content: application/json: schema: type: object properties: message: type: string required: - message '404': description: Customer not found content: application/json: schema: type: object properties: message: type: string required: - message '409': description: The request conflicts with the current configuration. content: application/json: schema: type: object properties: message: type: string required: - message security: - bearer: [] components: schemas: PaginatedAgentConsumptionEntry: type: object properties: meta: type: object properties: total: type: number description: Total of existing items. example: 1 taken: type: number description: Number of items returned. example: 1 skipped: type: number description: Number of items skipped. example: 0 required: - total - taken - skipped data: type: array items: type: object properties: currency: type: - string - 'null' enum: - EUR - AED - AFN - XCD - ALL - AMD - AOA - ARS - USD - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - XOF - BMD - BND - BOB - BRL - BSD - BTN - NOK - BWP - BYR - BZD - CAD - CDF - XAF - CHF - NZD - CLP - CNY - COP - CRC - CUP - CVE - ANG - CZK - DJF - DKK - DOP - DZD - EGP - MAD - ERN - ETB - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - XPF - NGN - NIO - NPR - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - UYU - UZS - VEF - VND - VUV - WST - YER - ZAR - ZMW - ZWL description: >- ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency. example: USD id: type: string description: Unique Hyperline identifier for this resource. example: d18603dd-7285-4bf5-a45e-88d7de8f37c9 agent_slug: type: - string - 'null' description: Agent scope identifier. Null is the customer's shared pool. example: support amount: type: string pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Exact amount in the accompanying denomination; monetary ledger amounts are fractional minor units. example: '12.5' denomination: type: string enum: - minor_units - credits - units description: >- Unit of account for amounts. - minor_units: Fractional minor units of the accompanying currency. - credits: Credit counts, without a currency. - units: Weighted rolling-allowance units, without a currency. example: minor_units breakdown: type: array items: type: object properties: kind: type: string enum: - llm_call - item - markup description: |- Receipt line kind. - llm_call: Model usage. - item: Non-LLM cost-item usage. - markup: Pricing markup applied to usage. example: llm_call provider: type: - string - 'null' description: >- AI model provider, or the vendor of a custom cost item. This is not an integration connection. example: anthropic model: type: - string - 'null' description: >- Model identifier, or custom item identifier. Null on wildcard pricing rows. example: claude-sonnet-5 quantity: type: - string - 'null' pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Quantity consumed, as an exact decimal string; null when not applicable. example: '1' unit: type: - string - 'null' description: Unit counted by the receipt quantity. example: request amount: type: string pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Exact amount in the accompanying denomination; monetary ledger amounts are fractional minor units. example: '12.5' denomination: type: string enum: - minor_units - credits - units description: >- Unit of account for amounts. - minor_units: Fractional minor units of the accompanying currency. - credits: Credit counts, without a currency. - units: Weighted rolling-allowance units, without a currency. example: minor_units usd_amount: type: - string - 'null' pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Underlying provider cost in USD major units, or null when unavailable. example: '0.125' rate: type: - string - 'null' description: >- Applied rate. Receipt lines may contain a human-readable rate expression. example: '3' price_status: type: string enum: - priced - partial - unpriced description: >- Pricing completeness. Omission on historical receipts means priced. - priced: All usage dimensions were priced. - partial: Some usage dimensions could not be priced. - unpriced: No price was available; zero means unknown cost, not free usage. example: priced required: - kind - provider - model - quantity - unit - amount description: >- Public itemized consumption receipt; storage metadata is excluded. example: [] unpriced_lines: type: number description: Number of unpriced lines. example: 0 overage: type: boolean description: >- Whether this entry was charged past the credit or allowance boundary, in currency minor units. example: false idempotency_key: type: string description: >- Replay key supplied when recording this consumption; retries preserve the original charge. example: usage_call_123 credit_transaction_id: type: - string - 'null' description: >- Credit transaction identifier for reconciliation; null outside credit consumption. example: null settled_at: type: - string - 'null' format: date-time description: >- Settled at, as a UTC ISO 8601 timestamp. Null when unavailable. example: null created_at: type: string format: date-time description: Creation time as a UTC ISO 8601 timestamp. example: '2026-09-01T00:00:00Z' required: - currency - id - agent_slug - amount - denomination - breakdown - unpriced_lines - overage - idempotency_key - credit_transaction_id - settled_at - created_at description: List of AgentConsumptionEntry. required: - meta - data securitySchemes: bearer: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.