Manage Endpoint Subscriptions

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

Last updated 5 months ago

List Workspace Endpoint Subscriptions

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

Path parameters

workspaceId*string

endpointId*string

Response

Body

results*array of Numbers_EndpointSubscription (object)

Request

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

Response

{
  "results": [
    {
      "name": "text",
      "status": "active",
      "price": {
        "currencyCode": "EUR",
        "amount": 0,
        "exponent": 0
      },
      "subscription": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "correlationId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "subscribedAt": "2025-01-18T02:49:01.600Z",
        "updatedAt": "2025-01-18T02:49:01.600Z",
        "canceledAt": "2025-01-18T02:49:01.600Z",
        "startAt": "2025-01-18T02:49:01.600Z",
        "endAt": "2025-01-18T02:49:01.600Z"
      }
    }
  ]
}