Skip to main content
POST
Renew user plan
When the owner’s balance cannot cover a plan’s renewal, the renewal waits and is tried again every hour (see Renewals). After you top up, this endpoint runs it right away. It is the Renew now button in the Plan action of your administration panel, shown while a renewal is pending. It is the same renewal as the hourly one. With monthly minutes, the user is topped back up to the plan’s minutes and gets its chat credits again, and the owner’s balance pays for the minutes they used. With yearly minutes, this month’s share comes from the prepaid 12 months, or, once they are over, what is left goes back and the next 12 months are taken. The next renewal is a month after this one.
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 renewed: any other ID, including the owner account, returns 404.

Path Parameters

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

Response

string
Plan renewed.
object
The user’s plan, as in Get user plan

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