Suspend an Organization

post

https://api.benjipays.com/v2/organizations/{organizationId}/suspend

Access: Requires DISTRIBUTOR actor type

Suspends an Organization by disabling access and billing. Used when a Partner (MSP) is not paying their distributor bill.

Requires JWT authentication and 'partners:organizations:suspend' scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

^[0-9a-fA-F]{24}$

MongoDB ObjectId of the organization

Body Params

Optional request body for suspend operation

reason

string

length ≤ 500

Optional reason for suspension

Headers

X-Request-ID

uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

X-Correlation-ID

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

Idempotency-Key

string

length between 1 and 255

^[a-zA-Z0-9]+$

Optional client-supplied key that makes retries safe for POST/PATCH/PUT. Scoped per actor; cached for 24 hours. Replays return the cached response with X-Idempotency-Replayed: true. Same key with a different body returns 409. In-flight duplicates return 429 with Retry-After. See the Idempotency section in the API overview.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Organization suspended successfully

401Unauthorized - Invalid or missing authentication token

403Forbidden - Distributor actor type required

404Not Found - Organization not found or does not belong to distributor

409Conflict - Organization is already suspended

429Too Many Requests - Rate limit exceeded