Cancel Number Subscription

"Cancel Number Subscription" API endpoint is deprecated, we suggest you to use Manage Endpoint Subscriptions APIs to cancel the subscription. You can use numberId as endpointId parameter and use main as a subscription name to achieve identical behavior.

Cancel Number Subscription

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

Path parameters

workspaceId*string

numberId*string

Response

200404

Updated Number

Body

application/json

typeNumbers_NumberInventoryType (enum)

The type of the number.

localnationaltollfreemobileshortcode

capabilitiesNumbers_NumberInventoryCapabilities (object)

The capabilities of the number.

numberNumbers_PhoneNumber (string)

The phone number in E.164 format.

countrystring (iso3166-1)

monthlyRecurringPriceMoney

Money combines an amount of money with its currency.

id*string (uuid)

The ID of the number.

status*Numbers_NumberStatus (enum)

The status of the number.

activeinactive

subscriptionNumberSubscriptionStatus

Describes status of Number Subscription

endpointSubscriptionNumbers_EndpointSubscriptionDetails (object)

configurationsNumbers_NumberConfigurations (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.

activatedAtnullable string (date-time)

Timestamp (UTC) of the last time the number was activated.

deactivatedAtnullable string (date-time)

Timestamp (UTC) of the last time the number was deactivated.

deactivatesAtnullable string (date-time)

Timestamp (UTC) when the number will be deactivated.

requirementsarray of Numbers_ComplianceRequirementStatus (object)

endpointNumbers_EndpointFragment (object)

whatsAppNumbers_WorkspaceWhatsAppNumber (object)

WhatsApp number pre-verification details.

Request

JavaScriptCurlPython

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

Response

200404

{
  "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": "text",
  "monthlyRecurringPrice": {
    "currencyCode": "EUR"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "subscription": {
    "status": "active",
    "subscribedAt": "2024-09-16T18:56:20.004Z",
    "updatedAt": "2024-09-16T18:56:20.004Z",
    "cancelledAt": "2024-09-16T18:56:20.004Z"
  },
  "endpointSubscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "subscribedAt": "2024-09-16T18:56:20.004Z",
    "updatedAt": "2024-09-16T18:56:20.004Z",
    "canceledAt": "2024-09-16T18:56:20.004Z",
    "startAt": "2024-09-16T18:56:20.004Z",
    "endAt": "2024-09-16T18:56:20.004Z"
  },
  "configurations": {
    "voice": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      }
    },
    "sms": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      }
    },
    "mms": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      }
    },
    "fax": {
      "inbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      },
      "outbound": {
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text"
      }
    },
    "whatsapp": {
      "connectorId": "123e4567-e89b-12d3-a456-426614174000",
      "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "connectorTemplateRef": "text"
    }
  },
  "createdAt": "2024-09-16T18:56:20.004Z",
  "updatedAt": "2024-09-16T18:56:20.004Z",
  "activatedAt": "2024-09-16T18:56:20.004Z",
  "deactivatedAt": "2024-09-16T18:56:20.004Z",
  "deactivatesAt": "2024-09-16T18:56:20.004Z",
  "requirements": [
    {
      "requirement": {
        "name": "text",
        "type": "kycForm",
        "scope": "number-activation",
        "selector": {
          "scope": "text",
          "numberType": "local",
          "countryCode": "text"
        }
      },
      "status": "ok",
      "reference": "text",
      "notOkSince": "2024-09-16T18:56:20.004Z"
    }
  ],
  "endpoint": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "long-code-number",
    "instanceId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "capabilities": [
      {
        "name": "sms",
        "inbound": {
          "status": "active",
          "issues": [
            "subscription-is-not-active"
          ]
        },
        "outbound": {
          "status": "active",
          "destinationStatuses": {
            "active": 0,
            "inactive": 0,
            "available": 0,
            "unavailable": 0
          },
          "supportsDestinations": false,
          "issues": [
            "subscription-is-not-active"
          ]
        }
      }
    ],
    "dependencies": [
      {
        "type": "connector",
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text",
        "capabilities": [
          "voice"
        ]
      }
    ],
    "issues": [
      "subscription-is-not-active"
    ],
    "provisioningStatus": "provisioned",
    "createdAt": "2024-09-16T18:56:20.004Z",
    "updatedAt": "2024-09-16T18:56:20.004Z"
  },
  "whatsApp": {
    "whatsAppId": "text",
    "status": "verified",
    "stage": "text",
    "nextAttemptAt": "2024-09-16T18:56:20.004Z",
    "verificationExpiresAt": "2024-09-16T18:56:20.004Z",
    "requestedCodeAt": "2024-09-16T18:56:20.004Z",
    "createdAt": "2024-09-16T18:56:20.004Z",
    "updatedAt": "2024-09-16T18:56:20.004Z"
  }
}