Cancel a long-term rental
Cancels an active rental and issues a wallet refund. Cancellation is only available within the first hour after creation (can_cancel: true). Once the cancel window has passed or the rental is no longer active, the call returns 409 CANCEL_NOT_ALLOWED.
Idempotency-Key is required: a network retry on a successful cancel replays the cached 200 instead of returning CANCEL_NOT_ALLOWED against the now-cancelled rental. Reusing the same key for a different rental returns 409 IDEMPOTENCY_CONFLICT.
On success the rental's status transitions to cancelled and a rental.cancelled webhook event is dispatched.
Request
- Base URL: https://dashboard.voidmob.com/api/v1
- URL: https://dashboard.voidmob.com/api/v1/rentals/{id}
- Auth: HTTP bearer
Path parameters
Opaque long-term rental identifier.
Long-term rental identifier (ren_ prefix).
Headers
Client-supplied key (any string, up to 255 chars) that scopes idempotent replay for write requests. Required on every POST, PATCH, and DELETE. Replays with the same key + same body return the cached response; same key with a different body returns IDEMPOTENCY_CONFLICT. Headers are case-insensitive; both Idempotency-Key and idempotency-key work.
Response
Rental cancelled.
Example response
{
"data": {
"id": "ren_01HXYZ123ABC",
"display_id": "SMS7K4P2N",
"phone_number": "+15551234567",
"service_id": "svc_telegram",
"service_name": "Telegram",
"country": "us",
"duration": "7D",
"charged_price_cents": 2500,
"next_renewal_price_cents": 2500,
"payment_due": {
"amount_cents": 1499
},
"re_rent_available": true,
"re_rent_price_cents": 2500,
"messages": [
{
"id": "msg_01HXYZ123ABC",
"code": "123456",
"text": "Your verification code is 123456."
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.