Skip to main content
DELETE
Delete user plan
This endpoint ends a plan you gave with Update user plan, for example when the customer cancels with you. The plan ends immediately: its unused minutes, and what is left of a yearly prepayment, go back to the owner’s balance, and the user keeps their other minutes and their chat credits. It is the Remove plan button in the Plan action of your administration panel. Without a plan, the user is handled like any other user without one: your default limits apply while free accounts are allowed, and if they are not, the account is deactivated, as when a paid plan ends.
This endpoint is available to the account owner (with an active plan) and to team members with Billing Access. Other users receive a 403 Forbidden error. Only users of your platform can be changed: any other ID, including the owner account, returns 404. Plans a user subscribed to on your platform cannot be removed here.
Deleting a user also ends the plan you gave them, and returns its unused minutes, and what is left of a yearly prepayment, to the owner’s balance.

Path Parameters

integer
required
The ID of the user. Administrators can list user IDs with Get platform users.

Response

string
Plan removed.
null
Always null: the user has no plan anymore

Rate limit

The platform settings, default limits, user settings and plan endpoints share a limit of 60 requests per minute for each account. Above it they return 429, and the Retry-After response header tells you how many seconds to wait.

Example