Manage Endpoint Subscriptions

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

List Workspace Endpoint Subscriptions

get

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstringrequired

endpointIdstringrequired

Responses

application/json

all ofoptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "results": [
    {
      "name": "text",
      "status": "active",
      "price": {
        "currencyCode": "EUR",
        "amount": 1,
        "exponent": 1
      },
      "subscription": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "correlationId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "subscribedAt": "2025-04-16T15:38:57.755Z",
        "updatedAt": "2025-04-16T15:38:57.755Z",
        "canceledAt": "2025-04-16T15:38:57.755Z",
        "startAt": "2025-04-16T15:38:57.755Z",
        "endAt": "2025-04-16T15:38:57.755Z"
      }
    }
  ]
}

Get Workspace Endpoint Subscription

get

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstringrequired

endpointIdstringrequired

subscriptionNamestringrequired

Responses

application/json

objectoptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "name": "text",
  "status": "active",
  "price": {
    "currencyCode": "EUR",
    "amount": 1,
    "exponent": 1
  },
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "subscribedAt": "2025-04-16T15:38:57.755Z",
    "updatedAt": "2025-04-16T15:38:57.755Z",
    "canceledAt": "2025-04-16T15:38:57.755Z",
    "startAt": "2025-04-16T15:38:57.755Z",
    "endAt": "2025-04-16T15:38:57.755Z"
  }
}

Activate Workspace Endpoint Subscription

post

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstringrequired

endpointIdstringrequired

subscriptionNamestringrequired

Body

quantityinteger · min: 1required

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}/activate HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "quantity": 1
}

{
  "name": "text",
  "status": "active",
  "price": {
    "currencyCode": "EUR",
    "amount": 1,
    "exponent": 1
  },
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "subscribedAt": "2025-04-16T15:38:57.755Z",
    "updatedAt": "2025-04-16T15:38:57.755Z",
    "canceledAt": "2025-04-16T15:38:57.755Z",
    "startAt": "2025-04-16T15:38:57.755Z",
    "endAt": "2025-04-16T15:38:57.755Z"
  }
}

Cancel Workspace Endpoint Subscription

post

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstringrequired

endpointIdstringrequired

subscriptionNamestringrequired

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/endpoints/{endpointId}/subscriptions/{subscriptionName}/cancel HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "name": "text",
  "status": "active",
  "price": {
    "currencyCode": "EUR",
    "amount": 1,
    "exponent": 1
  },
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "subscribedAt": "2025-04-16T15:38:57.755Z",
    "updatedAt": "2025-04-16T15:38:57.755Z",
    "canceledAt": "2025-04-16T15:38:57.755Z",
    "startAt": "2025-04-16T15:38:57.755Z",
    "endAt": "2025-04-16T15:38:57.755Z"
  }
}