Rentals

Get a long-term rental by id

Returns the full rental resource including all received messages. Poll every few seconds during active rentals; prefer webhooks for production use.

Use the messages_limit and messages_before query parameters to page through older messages when there are many.

If a renewal landed before it could be paid, payment_due shows the amount owed. It is collected automatically as soon as the balance covers it. SMS received meanwhile are stored but withheld (text/code null, content_withheld: true) until it is paid, and stay withheld if the term ends unpaid.

get/rentals/{id}

Request

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

Path parameters

idstring required

Opaque long-term rental identifier.

Example:ren_01HXYZ123ABC

Long-term rental identifier (ren_ prefix).

Query parameters

messages_limitinteger

Maximum number of messages to include.

messages_beforestring

Opaque message cursor. Returns messages older than this id.

Response

Current state of the rental including messages.

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.