Manage Endpoint Subscriptions

Manage your Number/ Sender ID subscription status, all sender types are considered "endpoints".

List Workspace Endpoint Subscriptions

GET/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions

Path parameters

workspaceId*string

endpointId*string

Response

200404

OK

Body

application/json

results*array of Numbers_EndpointSubscription (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "name": "text",
      "status": "active",
      "price": {
        "currencyCode": "EUR"
      },
      "subscription": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "correlationId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "subscribedAt": "2024-09-16T18:53:26.063Z",
        "updatedAt": "2024-09-16T18:53:26.063Z",
        "canceledAt": "2024-09-16T18:53:26.063Z",
        "startAt": "2024-09-16T18:53:26.063Z",
        "endAt": "2024-09-16T18:53:26.063Z"
      }
    }
  ]
}

Get Workspace Endpoint Subscription

GET/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}

Path parameters

workspaceId*string

endpointId*string

subscriptionName*string

Response

200404

OK

Body

application/json

name*string

status*Numbers_EndpointSubscriptionStatus (enum)

activeinactive

priceMoney

Money combines an amount of money with its currency.

subscriptionNumbers_EndpointSubscriptionDetails (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "name": "text",
  "status": "active",
  "price": {
    "currencyCode": "EUR"
  },
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "subscribedAt": "2024-09-16T18:53:26.063Z",
    "updatedAt": "2024-09-16T18:53:26.063Z",
    "canceledAt": "2024-09-16T18:53:26.063Z",
    "startAt": "2024-09-16T18:53:26.063Z",
    "endAt": "2024-09-16T18:53:26.063Z"
  }
}

Activate Workspace Endpoint Subscription

POST/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}/activate

Path parameters

workspaceId*string

endpointId*string

subscriptionName*string

Body

application/json

quantity*integer

Response

200404

OK

Body

application/json

name*string

status*Numbers_EndpointSubscriptionStatus (enum)

activeinactive

priceMoney

Money combines an amount of money with its currency.

subscriptionNumbers_EndpointSubscriptionDetails (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}/activate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404

{
  "name": "text",
  "status": "active",
  "price": {
    "currencyCode": "EUR"
  },
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "subscribedAt": "2024-09-16T18:53:26.063Z",
    "updatedAt": "2024-09-16T18:53:26.063Z",
    "canceledAt": "2024-09-16T18:53:26.063Z",
    "startAt": "2024-09-16T18:53:26.063Z",
    "endAt": "2024-09-16T18:53:26.063Z"
  }
}

Cancel Workspace Endpoint Subscription

POST/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}/cancel

Path parameters

workspaceId*string

endpointId*string

subscriptionName*string

Response

200404

OK

Body

application/json

name*string

status*Numbers_EndpointSubscriptionStatus (enum)

activeinactive

priceMoney

Money combines an amount of money with its currency.

subscriptionNumbers_EndpointSubscriptionDetails (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}/cancel', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "name": "text",
  "status": "active",
  "price": {
    "currencyCode": "EUR"
  },
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "subscribedAt": "2024-09-16T18:53:26.063Z",
    "updatedAt": "2024-09-16T18:53:26.063Z",
    "canceledAt": "2024-09-16T18:53:26.063Z",
    "startAt": "2024-09-16T18:53:26.063Z",
    "endAt": "2024-09-16T18:53:26.063Z"
  }
}