Billing & FinOps

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.

Purchase a configured or recommended commitment

POST
/scopes/{scopeId}/billing/commitments/{commitmentId}/actions/purchase

Executes the purchase of the referenced commitment. This single operation backs both UI triggers: the "Purchase commitment" confirmation at the end of the commitment creation form flow (finalizing a QUEUED draft) and the one-click "Purchase" button on an advisor recommendation card of the Commitments page (purchasing the recommended plan materialized as a QUEUED commitment). Purchasing charges any upfront amount per the payment option, locks the hourly committed rate for the term, and schedules activation; the resulting state is available to subsequent reads of the list and detail endpoints. A NO_UPFRONT purchase goes QUEUED → ACTIVE at once; an upfront-bearing (PARTIAL_UPFRONT|ALL_UPFRONT) purchase goes QUEUED → PENDING_ACTIVATION and opens a pending-manual-approval upfront charge — the commitment becomes ACTIVE only when Finance confirms that charge, and terminally REJECTED if Finance marks that charge never-received instead. Validation: the commitment must exist and be visible in the active scope (else 404 NOT_FOUND); its current state must permit purchase — only QUEUED commitments are purchasable, a PENDING_ACTIVATION, REJECTED, ACTIVE, EXPIRING or EXPIRED commitment maps to 409 CONFLICT; the caller must hold owner|admin|billing on the scope, else 403. Async & state: Conditionally asynchronous — returns 202 with an Operation (PENDING → RUNNING → SUCCEEDED|FAILED). On success the commitment transitions QUEUED → ACTIVE and a resource.updated SSE frame of kind billing.commitment is emitted (patch with status, startedAt, expiresAt, upfront); on payment failure the Operation terminates FAILED with an ApiError and the commitment remains QUEUED. Errors: 401 unauthenticated; 403 insufficient role; 404 unknown scope or commitment; 409 the commitment is not in a purchasable state or a purchase is already in flight; 422 malformed request; 500 internal failure. Idempotency/Concurrency: Idempotency-Key is optional (recommended) — replaying the same key returns the original 202 Operation and never double-charges. This operation does not check If-Match; a sent one is ignored (the state guard above refuses a commitment that is no longer QUEUED).

Authorization

bearerToken
headerAuthorizationBearer <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.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

commitmentId*string

Identifier of the commitment within the active scope.

Header Parameters

Idempotency-Key?string

Optional; recommended for safe retries. When sent, the same key+body within 24h replays the original result and the same key with a different body is 409 CONFLICT; keys are unique per tenant. When an API token or service-account (bearer) caller omits it, the request is applied once with no replay protection (a retry may apply it again). A console session gets one from the edge.

Formatuuid

Response Body

Purchase accepted; track settlement through the returned Operation.

application/json
  1. response

A long-running operation record. GET /operations/{operationId} returns its current state.

id*string

Operation identifier, unique platform-wide.

action*string

Canonical action id that started this operation, e.g. compute.instance.create.

state*OperationState

State machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.

Value in"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.

Range0 <= value <= 100
error?|null

Populated only when state is FAILED (or CANCELLED with partial rollback notes).

warning?|null

Non-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*string
updatedAt*string
curl -X POST "https://example.com/scopes/string/billing/commitments/string/actions/purchase"
{  "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"}