Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Export a transaction ledger entry as CSV (legacy compat)
Deprecated
Legacy compat shim for exporting a transaction ledger entry as CSV (originally the "Export CSV"
action on the account-statement tab). Deprecated — new integrations should call
GET .../transactions/{transactionId}/exports/download instead, which streams the CSV
synchronously in a single request; this POST is retained only so existing callers keep working.
No ledger state is mutated by this command.
Validation: scope and transaction context must exist and be visible (else NOT_FOUND); caller
needs reader-or-higher or billing role, otherwise FORBIDDEN.
Async & state: Despite the historical 202 status code, this call completes synchronously —
there is no background job, no queued/processing progression, and no signed downloadUrl in
the result. The returned body is an already-SUCCEEDED Operation (not a TransactionExport job);
the CSV bytes are NOT attached to this response — fetch them via GET .../exports/download.
Errors: 401 unauthenticated; 403 caller lacks billing read permission; 404 unknown
scope/transaction; 500 renderer failure.
Idempotency/Concurrency: This operation does not use Idempotency-Key; it may be omitted
and a sent one is ignored. Every call returns a freshly minted, already-succeeded Operation (a
new id each time) and changes nothing.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
transactionId*stringTransaction ledger entry identifier anchoring the export.
application/json- body
Input for exporting the transaction ledger / account statement.
format*TransactionExportInputFormatRequested transaction-export artifact format.
"csv""pdf"period?|Statement month to export (e.g. 2026-05); null exports the current ledger view.
Legacy compat response — an already-SUCCEEDED Operation with no artifact attached (download via the GET endpoint).
application/json- response
A long-running operation record. GET /operations/{operationId} returns its current state.
id*stringOperation identifier, unique platform-wide.
action*stringCanonical action id that started this operation, e.g. compute.instance.create.
state*OperationStateState machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.
"PENDING""RUNNING""SUCCEEDED""FAILED""CANCELLED"resourceKind?|Kind of the target resource (matches RealtimeEvent.kind), null for resource-less actions.
resourceId?|Identifier of the target resource; null until the resource is allocated.
resourceName?|Human-readable name of the target resource captured when the operation was opened; null when unknown or the resource has been deleted (clients fall back to resourceId).
principalId?|Subject id (user id/email or service-account id) of the actor that initiated this operation, captured at the create chokepoint; null on internal/worker paths with no request-scoped principal or for historical rows. This is the real actor the Activity feed renders.
sourceIp?|Source IP address of the request that initiated this operation; null when unavailable (internal/worker paths, historical rows).
progressPercent?|Best-effort progress; null when the action does not report progress.
0 <= value <= 100error?|nullPopulated only when state is FAILED (or CANCELLED with partial rollback notes).
warning?|nullNon-fatal degradation recorded on an operation that still SUCCEEDED - the primary action completed but something explicitly requested could not be delivered (e.g. publicIp was requested at instance create but no floating IP could be assigned). On a CANCELLED create it reports that the provider resource had already been created and was kept (live and billed until deleted; details.disposition = left_in_place). Same code+message shape as error so clients render both uniformly; null when the operation ran without degradation.
startedAt?|When the worker began executing; null while PENDING.
finishedAt?|When a terminal state was reached; null while transitional.
createdAt*stringupdatedAt*stringcurl -X POST "https://example.com/scopes/string/billing/transactions/string/exports" \ -H "Content-Type: application/json" \ -d '{ "format": "csv" }'{ "id": "string", "action": "string", "state": "PENDING", "resourceKind": "string", "resourceId": "string", "resourceName": "string", "principalId": "string", "sourceIp": "string", "progressPercent": 0, "error": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "warning": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "startedAt": "string", "finishedAt": "string", "createdAt": "string", "updatedAt": "string"}