Export redacted customer ledger usage as JSON or CSV.

Admin-only customer usage export. Returns ledger totals and rows without prompts, outputs, request bodies, token hashes, gateway secrets, or raw credentials.

GET /v1/admin/customers/{customer_id}/usage-export

Admin-only customer usage export. Returns ledger totals and rows without prompts, outputs, request bodies, token hashes, gateway secrets, or raw credentials.

Authentication

API Key (header: X-B3IQ-Admin-Token)

Path Parameters

customer_id string required path

Query Parameters

window_days integer optional query

limit integer optional query

format string optional query

Responses

200 Redacted customer usage export.

application/json

object string

Enum: b3iq.admin.customer_usage_export

generated_at string (date-time)

export_policy string

Enum: customer_usage_export_v1

contains_request_content boolean

customer object

usage object

totals object[]

Array of:

kind string

count integer

amount_wei string

entries object[]

Array of:

entry_id string

private_job_id string | null

receipt_hash string | null

kind string

amount_wei string

balance_after_wei string

reserved_after_wei string

created_at string (date-time)

default B3IQ-native problem response.

curl -X GET 'https://{controlPlaneHost}/v1/admin/customers/string/usage-export' \  -H 'X-B3IQ-Admin-Token: YOUR_API_KEY'

const response = await fetch('https://{controlPlaneHost}/v1/admin/customers/string/usage-export', {  method: 'GET',  headers: {      "X-B3IQ-Admin-Token": "YOUR_API_KEY"  }});const data = await response.json();console.log(data);

200 Response

{  "object": "b3iq.admin.customer_usage_export",  "generated_at": "2024-01-01T00:00:00Z",  "export_policy": "customer_usage_export_v1",  "contains_request_content": true,  "customer": "<object>",  "usage": {    "totals": [      {        "kind": "<string>",        "count": 123,        "amount_wei": "<string>"      }    ],    "entries": [      {        "entry_id": "<string>",        "private_job_id": "<string>",        "receipt_hash": "<string>",        "kind": "<string>",        "amount_wei": "<string>",        "balance_after_wei": "<string>",        "reserved_after_wei": "<string>",        "created_at": "2024-01-01T00:00:00Z"      }    ]  }}

default Response

{  "error": {    "status": 123,    "title": "<string>",    "detail": "<string>",    "code": "<string>"  }}

GET /v1/admin/customers/{customer_id}/usage-export

Base URL

Path Parameters

customer_id string required

Query Parameters

window_days integer

limit integer

format string

Response

Was this page helpful?

Previous Credit a prepaid customer balance.

Next Read the current bootstrap admin role session.