Suspend Stripe Connection

POST/web/v1/workspaces/{workspaceId}/stripe/connections/{connectionBizId}/suspendJWT

Suspends an active Stripe connection, temporarily disabling payment processing and webhook delivery through this connection.

Authentication

Auth Chain: WEB Chain — requires Authorization: Bearer <jwt> Requires workspace:manage permission. These headers are injected by the system (frontend does nothing): X-PORTAL-ACCESS-CODE (Nginx), X-Request-Id (Gateway)

Request Parameters

Name	Type	Required	In	Description
workspaceId	string	Yes	path	Workspace business ID
connectionBizId	string	Yes	path	Business ID of the connection to suspend

Success Response

Success200

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "sc_abc123",
    "tenantBizId": "tn_xyz789",
    "connectionName": "Production Stripe",
    "connectionDescription": "Main production connection",
    "stripeAccountId": "acct_1234567890",
    "partnerEndpoint": "https://partner.example.com/webhook",
    "configJson": null,
    "status": 2,
    "statusName": "SUSPENDED",
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T02:00:00Z"
  }
}

Error Responses

Unauthorized401

{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Not Found404

{
  "success": false,
  "code": "4040",
  "message": "Stripe tenant connection not found"
}

Notes

• Suspending a connection does not delete the stored credentials; they are preserved for reactivation.
• A suspended connection can be reactivated via the Activate Stripe Connection endpoint.
• Requires the workspace:manage permission on the target workspace.