Skip to main content

Interface: WorkspaceSendingStatusResponse

Defined in: packages/sdk/src/types/generated/billing.ts:753

Whether outbound sending is credit-stopped for a workspace, and the remedy.

The bounded, action-only projection a workspace admin without a billing role may read (GRA-9085). It carries NO balance, no balance history, no billing PII, no subscription internals, and no recipient or message data — only the stop state, its bounded reason, and the next step.

Derived from the durable subscription row through the org-anchor readers in lib.db.glb.subscription_resolution (resolve_workspace_billing_state and its companions), never from the 5-minute billing:org:* Redis keys the enforcement fast path reads, so this surface cannot report the harder "sending is suspended" claim from a cached value that the durable row does not back.

Properties​

nextStep?​

optional nextStep: SendingNextStep | null

Defined in: packages/sdk/src/types/generated/billing.ts:759

The remedy that clears this stop, or null when nothing is stopped. Whether THIS viewer may perform it is the caller's decision.

reason?​

optional reason: WorkspaceSendingStatusResponseReason

Defined in: packages/sdk/src/types/generated/billing.ts:757

Bounded reason for the stop — credit_exhaustion, operator_hold, or billing_unresolved — or null when nothing is suspended. Deliberately NOT the raw usage_suspension_reason, which can carry operator free text.

state​

state: SendingStopState

Defined in: packages/sdk/src/types/generated/billing.ts:755

Why outbound sending is stopped, or ok. Never a provider outage.