Cancel a Number

Cancel Number Subscription

POST/workspaces/{workspaceId}/numbers/{numberId}/cancel-subscription

Authorization

useraccessKey

Path parameters

workspaceId*string

numberId*string

Response

200404

Updated Number

Body

application/json

typeNumberInventoryType (enum)

The type of the number.

localnationaltollfreemobileshortcode

capabilitiesNumberInventoryCapabilities (object)

The capabilities of the number.

numberPhoneNumber (string)

The phone number in E.164 format.

countryCountryCode (enum)

The country code in ISO3166-1 format.

ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXKYEYTYUZAZMZRZW

monthlyRecurringPriceMoney

Money combines an amount of money with its currency.

id*string (uuid)

The ID of the number.

status*NumberStatus (enum)

The status of the number.

activeinactive

subscriptionNumberSubscriptionStatus

Describes status of Number Subscription

configurationsNumberConfigurations (object)

createdAt*string (date-time)

Timestamp (UTC) when the number was created.

updatedAt*nullable string (date-time)

Timestamp (UTC) when the number was last updated.

requirementsarray of ComplianceRequirementStatus (object)

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/numbers/{numberId}/cancel-subscription', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "type": "local",
  "capabilities": {
    "sms": {
      "inbound": false,
      "outbound": false
    },
    "voice": {
      "inbound": false,
      "outbound": false
    },
    "mms": {
      "inbound": false,
      "outbound": false
    },
    "fax": {
      "inbound": false,
      "outbound": false
    }
  },
  "number": "text",
  "country": "AC",
  "monthlyRecurringPrice": {
    "currencyCode": "EUR"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "subscription": {
    "status": "active",
    "subscribedAt": "2024-04-29T16:30:00.602Z",
    "updatedAt": "2024-04-29T16:30:00.602Z",
    "cancelledAt": "2024-04-29T16:30:00.602Z"
  },
  "configurations": {
    "voice": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "sms": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "mms": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "fax": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "whatsapp": {
      "connectorId": "123e4567-e89b-12d3-a456-426614174000",
      "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "createdAt": "2024-04-29T16:30:00.602Z",
  "updatedAt": "2024-04-29T16:30:00.602Z",
  "requirements": [
    {
      "requirement": {
        "name": "text",
        "type": "kycForm",
        "scope": "number-activation",
        "selector": {
          "scope": "text",
          "numberType": "local",
          "countryCode": "AC"
        }
      },
      "status": "ok",
      "reference": "text"
    }
  ]
}