Skip to main content
POST
Revoke a customer (partner offboarding)

Authorizations

X-API-Key
string
header
required

Path Parameters

customer_id
string
required

Public customer id returned on create

Example:

"pcus_a1b2c3d4e5f6"

Body

application/json
reason
string | null

Optional partner audit note (not returned in API responses).

Maximum string length: 512
Example:

"account_closed"

Response

Customer revoked or already offboarded

status
enum<string>
required
Available options:
success
message
string
required
data
object
required