Dedicated Numbers

Toggle auto-renew for a dedicated number

Sets auto-renew to the specified state for a dedicated number owned by the authenticated user. Unlike a flip toggle, this is idempotent - calling with the same enabled value twice is safe.

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

Some UK, Hong Kong and Indonesia renewals are locked in during the last days of the period. Turning auto-renew off then returns 400 VALIDATION_ERROR ("Auto-renew can't be turned off this close to the renewal. This term will renew."). Turning it on then renews the number right away, so the next period is charged first; without enough balance the call returns 402 INSUFFICIENT_BALANCE and nothing changes.

post/dedicated/numbers/{id}/auto_renew

Request

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

Path parameters

idstring required

Dedicated number id prefixed ded_.

Request body

enabledboolean required

Set to true to enable auto-renew, false to disable.

Response

Auto-renew state updated. Returns the updated dedicated number.

successtrue required

Example response

{
  "data": {
    "id": "ded_abc123",
    "display_id": "DED1",
    "phone_number": "+4915123456789",
    "country": "de",
    "country_name": "Germany",
    "quoted_price_cents": 3499,
    "charged_price_cents": 3499,
    "next_renewal_price_cents": 3499,
    "payment_due": {
      "amount_cents": 1499
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.