Customers
Archive customer
Archives a customer, preventing new subscriptions. Optionally cancels existing subscriptions.
post/api/v1/customers/{id}/archive
Path parameters
idstring required
The unique identifier of the entity
Headers
X-ACCOUNT-IDstring
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
X-ENVIRONMENT-IDstring
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Response
The archived customer object.