Numbers & Inventory

Delete purchased numbers

Cancel purchase of DID numbers and return them to inventory.

Important notes:

  • Can cancel multiple numbers in a single request
  • Numbers are returned to seller's inventory
  • Optional quarantine period before number becomes available again
  • Refund policy depends on service terms

When to use:

  • User wants to cancel number purchase
  • Returning numbers after unsuccessful activation
  • Bulk number release

Partial cancellation: Numbers not present in your cancelable inventory are skipped (not cancelled) and reported in the warnings array with code not_in_inventory. If none of the requested numbers are cancelable, the request returns 422.

A number that is cancelable but whose cancellation fails is reported with code cancellation_failed and is omitted from dids; it remains in your inventory and is still billable. A request where every number fails this way returns 200 with an empty dids array.

delete/api/v2/numbers/purchase

Request

  • Base URL: https://app.didlogic.com
  • URL: https://app.didlogic.com/api/v2/numbers/purchase
  • Auth: HTTP bearer

Query parameters

id_in[]integer[]

Array of DID IDs to cancel, from numbers_index

[
  1001,
  1002
]
did_numbers[]string[]

Array of DID numbers to cancel, from numbers_index, purchases_index

[
  "12125551234",
  "12125551235"
]

Response

cancels owned numbers and reports skipped ones as warnings

Example response

{
  "dids": [
    {
      "id": 369,
      "number": "79090160010",
      "channels": 1,
      "country": "Fake country for 79090160010",
      "area": "Fake city for 79090160010",
      "commitment_months": 12,
      "activation": 1.17,
      "monthly_fee": 1.17,
      "per_minute": 0.117
    }
  ],
  "warnings": [
    {
      "resource": "caller_id",
      "identifier": "19999999999",
      "code": "not_an_owned_or_verified_caller_id",
      "message": "is not an owned or verified caller ID and was ignored"
    }
  ]
}

Changes

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