Rentals

Enable or disable auto-renew on a rental

Sets the auto_renew flag to an explicit state. Unlike a toggle, calling with the same enabled value twice is safe (idempotent by construction). No Idempotency-Key header is required.

When enabled: true, the rental will automatically renew for the same duration at expiry, charged to your balance shortly before paid_until. When enabled: false, the rental expires normally when expires_at is reached.

Turning auto-renew off after the next term was already charged refunds that charge to your balance. If the renewal is already under way, the call returns 400 VALIDATION_ERROR ("This rental is already renewing and the next term is paid. Turn auto-renew off after it renews.") and auto-renew stays on.

Returns 400 VALIDATION_ERROR if the rental has already expired.

post/rentals/{id}/auto_renew

Request

  • Base URL: https://dashboard.voidmob.com/api/v1
  • URL: https://dashboard.voidmob.com/api/v1/rentals/{id}/auto_renew
  • Auth: HTTP bearer

Path parameters

idstring required

Opaque long-term rental identifier.

Example:ren_01HXYZ123ABC

Long-term rental identifier (ren_ prefix).

Headers

Idempotency-Keystring

Optional on this endpoint. The body is an explicit state setter, so repeated calls with the same enabled value are no-ops at the backend regardless of this header. Include one if your client uniformly tags every mutation - it is accepted but not enforced.

Request body

enabledboolean required

true to enable auto-renew; false to disable. Explicit state (not a toggle) - calling with the same value twice is safe.

Response

Auto-renew preference updated. Returns the updated rental.

successtrue required

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.