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.
Resume a paused billing subscription
Resumes the account-level billing subscription ("Resume" in the detail header, the inverse of
"Pause"). Provisioning gates that were blocked while the subscription sat in FREEZE are lifted
once the resume propagates; already-running resources were never interrupted by the pause, so
nothing is provisioned or restarted by this action.
Validation: billingSubscriptionId must identify a subscription visible to the caller in
scopeId (else 404 NOT_FOUND); the caller must hold owner|admin (mirroring pause; else 403); a
malformed Idempotency-Key maps to 422 VALIDATION_FAILED.
Async & state: Synchronous — the write completes inline (no async worker) and returns an
already-SUCCEEDED Operation whose id IS the request's Idempotency-Key. The subscription state is
set to ACTIVE and is reflected by the account
detail read model immediately; unlike pause, resume does not gate on the current state — a resume
on an already-ACTIVE subscription is a no-op upsert (no 409 CONFLICT) and there is no If-Match
precondition.
Errors: 401 unauthenticated; 403 role may not resume this subscription; 404
unknown/invisible billingSubscriptionId; 422 malformed Idempotency-Key; 500 internal.
Idempotency/Concurrency: Idempotency-Key is optional (recommended); replaying the same
key returns the
original Operation without a second write.
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.
billingSubscriptionId*stringIdentifier of the account-level billing subscription to resume.
Idempotency-Key?stringOptional; 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.
uuidResume accepted; the returned Operation is already SUCCEEDED (FREEZE → ACTIVE applied inline).
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/subscriptions/string/actions/resume"{ "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"}