---
updatedAt: 2026-08-28T16:29:31.000Z
---

# Delete Subscription

Permanently deletes an existing subscription by its `subscriptionId`. Once deleted, the subscription cannot be recovered and will stop delivering events immediately.

## Finding Your Customer Subdomain

Your subdomain is found in your Avaya Infinity portal URL and is required for all API calls.

**Example:** If your portal URL is:

```
https://core.avaya1234.ec.avayacloud.com/app/core-config-ui/
```

Your subdomain is: **`avaya1234`**

**To use this API:**

1. **Find your subdomain** from your Infinity portal URL (as shown above)
2. **Get your Bearer token** using the `EVENT_NOTIFICATION` client credential (see Authentication below)
3. **In the API explorer on the right:**
   * Click on `{customerId}` in the URL field and replace it with your actual subdomain
   * Paste your Bearer token in the Credentials section
   * Enter the `subscriptionId` of the subscription to delete

## Authentication

This endpoint requires a valid OAuth 2.0 Bearer token. To get started, contact Avaya Support to request a `client_id` and `client_secret` provisioned with the `EVENT_NOTIFICATION` scope.

Once you have your credentials, [generate an access token](https://developers.avayacloud.com/avaya-infinity/reference/access-token) and include it in the `Authorization: Bearer <token>` header of each request.


## Important Notes

* **This action cannot be undone.** Confirm the correct `subscriptionId` before proceeding.
* Returns `204 No Content` on success — no response body is returned.
* Returns a `404` if no subscription exists with the specified ID.

## Rate Limiting

* This endpoint implements DOS protection and rate limiting. If you receive a `429 Too Many Requests` response, implement exponential backoff before retrying.


# OpenAPI definition

````json
{
  "openapi": "3.0.3",
  "x-explorer-enabled": false,
  "x-samples-languages": [
    "curl",
    "node",
    "java",
    "javascript",
    "python",
    "go"
  ],
  "info": {
    "title": "Notifications API",
    "description": "Subscribe to and manage real-time event streams from Avaya Infinity™. Register webhook endpoints to receive live notifications for agent activity (login, logout, ready/not-ready state changes) and interaction lifecycle events (created, completed, transferred). Subscriptions are time-limited and must be renewed before expiry to remain active.\n\n## Endpoints\n\n### Create Subscription\n\n`POST /subscriptions`\n\nCreates a new webhook subscription for one or more event families.\n\n[View API Reference →](https://developers.avayacloud.com/avaya-infinity/reference/createsubscription)\n\n### List Subscriptions\n\n`GET /subscriptions`\n\nReturns a paginated list of existing subscriptions.\n\n[View API Reference →](https://developers.avayacloud.com/avaya-infinity/reference/listsubscriptions)\n\n### Get Subscription\n\n`GET /subscriptions/{subscriptionId}`\n\nReturns a single subscription by its ID.\n\n[View API Reference →](https://developers.avayacloud.com/avaya-infinity/reference/getsubscription)\n\n### Update Subscription\n\n`PATCH /subscriptions/{subscriptionId}`\n\nPartially updates a subscription's event families, events, or transport configuration.\n\n[View API Reference →](https://developers.avayacloud.com/avaya-infinity/reference/updatesubscription)\n\n### Renew Subscription\n\n`POST /subscriptions/{subscriptionId}:renew`\n\nRenews an active or inactive subscription before or after expiry, optionally updating the webhook auth token.\n\n[View API Reference →](https://developers.avayacloud.com/avaya-infinity/reference/renewsubscription)\n\n### Delete Subscription\n\n`DELETE /subscriptions/{subscriptionId}`\n\nPermanently deletes a subscription by its ID.\n\n[View API Reference →](https://developers.avayacloud.com/avaya-infinity/reference/deletesubscription)\n\n## Getting Started\n\n### Find Your Customer Subdomain\n\nYour subdomain is found in your Infinity portal URL and is required for all API calls.\n\n**Example:** If your portal URL is:\n\n```\nhttps://core.avaya1234.ec.avayacloud.com/app/core-config-ui/\n```\n\nYour subdomain is: **`avaya1234`**\n\nAll API requests use this format:\n\n```\nhttps://core.{customerId}.ec.avayacloud.com/api/events/v1/...\n```\n\n### Authentication\n\nAll endpoints require Bearer token authentication. To get started, contact Avaya Support to request a `client_id` and `client_secret` provisioned with the `EVENT_NOTIFICATION` scope. Once you have your credentials, [generate an access token](https://developers.avayacloud.com/avaya-infinity/reference/access-token).\n\n### Working with Subscriptions\n\nSubscriptions follow a simple lifecycle:\n\n1. **Create** — register your webhook endpoint and select the event families and events to receive\n2. **Active** — your webhook receives events in real time while the subscription is active\n3. **Renew** — call the Renew endpoint before `expiresIn` reaches zero to keep the subscription active\n4. **Inactive** — if not renewed in time, the subscription becomes `INACTIVE` and stops delivering events; it can be reactivated via the Renew endpoint\n\nThe `expiresIn` field in every response shows the seconds remaining before the subscription expires.\n\n### Common Integration Patterns\n\n**Agent Activity Monitoring** — Subscribe to the `AGENT` family to track login, logout, ready, and not-ready state changes in real time for workforce management or reporting dashboards.\n\n**Interaction Lifecycle Tracking** — Subscribe to the `INTERACTION` family to trigger downstream workflows when interactions are created, completed, or transferred.\n\n**Webhook Token Rotation** — Use the Renew endpoint to update your `authToken` at the same time as renewing the subscription, keeping your webhook verification token fresh without recreating the subscription.\n",
    "version": "1.0.0",
    "contact": {
      "name": "Avaya Developer Support",
      "url": "https://developers.avayacloud.com/avaya-infinity/"
    }
  },
  "tags": [
    {
      "name": "Subscriptions",
      "description": "Subscriptions can be created to register for streams of real-time event notifications.\n"
    }
  ],
  "security": [
    {},
    {
      "BearerAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://core.{customerId}.ec.avayacloud.com/api/events/v1",
      "description": "Production",
      "variables": {
        "customerId": {
          "description": "Your organization subdomain identifier (e.g., avaya1234)",
          "default": "avaya1234"
        }
      }
    }
  ],
  "paths": {
    "/subscriptions/{subscriptionId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/subscriptionId"
        }
      ],
      "delete": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Delete Subscription",
        "description": "Permanently deletes an existing subscription by its `subscriptionId`. Once deleted, the subscription cannot be recovered and will stop delivering events immediately.\n\n## Finding Your Customer Subdomain\n\nYour subdomain is found in your Avaya Infinity portal URL and is required for all API calls.\n\n**Example:** If your portal URL is:\n\n```\nhttps://core.avaya1234.ec.avayacloud.com/app/core-config-ui/\n```\n\nYour subdomain is: **`avaya1234`**\n\n**To use this API:**\n\n1. **Find your subdomain** from your Infinity portal URL (as shown above)\n2. **Get your Bearer token** using the `EVENT_NOTIFICATION` client credential (see Authentication below)\n3. **In the API explorer on the right:**\n   * Click on `{customerId}` in the URL field and replace it with your actual subdomain\n   * Paste your Bearer token in the Credentials section\n   * Enter the `subscriptionId` of the subscription to delete\n\n## Authentication\n\nThis endpoint requires a valid OAuth 2.0 Bearer token. To get started, contact Avaya Support to request a `client_id` and `client_secret` provisioned with the `EVENT_NOTIFICATION` scope.\n\nOnce you have your credentials, [generate an access token](https://developers.avayacloud.com/avaya-infinity/reference/access-token) and include it in the `Authorization: Bearer <token>` header of each request.\n\n\n## Important Notes\n\n* **This action cannot be undone.** Confirm the correct `subscriptionId` before proceeding.\n* Returns `204 No Content` on success — no response body is returned.\n* Returns a `404` if no subscription exists with the specified ID.\n\n## Rate Limiting\n\n* This endpoint implements DOS protection and rate limiting. If you receive a `429 Too Many Requests` response, implement exponential backoff before retrying.\n",
        "operationId": "deleteSubscription",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "OAuth 2.0 Bearer token. Required.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "Subscription deleted successfully. No content returned."
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/InternalServer"
          }
        },
        "deprecated": false,
        "x-internal": false
      }
    }
  },
  "components": {
    "parameters": {
      "subscriptionId": {
        "name": "subscriptionId",
        "description": "The unique 36 character internal id that represents the subscription.",
        "required": true,
        "in": "path",
        "schema": {
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$",
          "example": "fdbec917-e76e-4645-8120-4eac46f29487"
        }
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "examples": {
              "default": {
                "$ref": "#/components/examples/ErrorUnauthorized"
              }
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "examples": {
              "default": {
                "$ref": "#/components/examples/ErrorForbidden"
              }
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "examples": {
              "default": {
                "$ref": "#/components/examples/ErrorNotFound"
              }
            }
          }
        }
      },
      "InternalServer": {
        "description": "Internal Server Error",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "examples": {
              "default": {
                "$ref": "#/components/examples/ErrorInternalServerError"
              }
            }
          }
        }
      }
    },
    "schemas": {
      "Problem": {
        "type": "object",
        "description": "Problem detail as defined by RFC 7807 — a standard way to carry machine-readable error details in HTTP responses.\n",
        "required": [
          "type",
          "title",
          "status"
        ],
        "additionalProperties": false,
        "properties": {
          "type": {
            "type": "string",
            "format": "uri",
            "description": "A URI identifying the problem type.\n",
            "default": "about:blank",
            "example": "https://developers.avayacloud.com/avaya-infinity/docs/error-handling#constraint-violation"
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type.\n",
            "example": "Service Unavailable",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "The HTTP status code for this occurrence of the problem.\n",
            "minimum": 100,
            "maximum": 600,
            "exclusiveMaximum": true,
            "example": 503,
            "nullable": true
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem.\n",
            "example": "Connection to database timed out",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "format": "uri",
            "description": "A URI identifying the specific occurrence of the problem.\n",
            "nullable": true
          },
          "violations": {
            "type": "array",
            "description": "A list of field-level validation violations, present on 400 responses.\n",
            "nullable": true,
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string",
                  "description": "The name of the field that caused the violation.\n",
                  "example": "family"
                },
                "message": {
                  "type": "string",
                  "description": "A human-readable explanation of the violation.\n",
                  "example": "must not be null"
                },
                "code": {
                  "type": "integer",
                  "format": "int32",
                  "description": "A stable violation code. Use this in error handling logic — the message text may change.\n",
                  "example": 20006
                }
              }
            },
            "example": [
              {
                "field": "family",
                "message": "must not be null",
                "code": 20002
              }
            ]
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth 2.0 Bearer Token authentication using the client credentials flow.\n\nTo get started, contact Avaya Support to request a `client_id` and `client_secret` provisioned with the `EVENT_NOTIFICATION` scope.\n\nOnce you have your credentials, [generate an access token](https://developers.avayacloud.com/avaya-infinity/reference/access-token) and include it as: `Authorization: Bearer <access_token>`\n\n```\nPOST https://core.avaya1234.ec.avayacloud.com/auth/realms/avaya/protocol/openid-connect/token\nContent-Type: application/x-www-form-urlencoded\n\ngrant_type=client_credentials&client_id=<your_client_id>&client_secret=<your_client_secret>&scope=EVENT_NOTIFICATION\n```\n",
        "bearerFormat": "JWT"
      }
    },
    "examples": {
      "ErrorUnauthorized": {
        "description": "Unauthorized",
        "value": {
          "type": "https://developers.avayacloud.com/avaya-infinity/docs/error-handling#unauthorized",
          "title": "Unauthorized",
          "status": 401,
          "detail": "This operation requires authentication. See https://developers.avayacloud.com/avaya-infinity/docs/how-to-authenticate-with-avaya-infinitytm-apis"
        }
      },
      "ErrorForbidden": {
        "description": "Forbidden",
        "value": {
          "type": "https://developers.avayacloud.com/avaya-infinity/docs/error-handling#forbidden",
          "title": "Forbidden",
          "status": 403,
          "detail": "According to the access control policy the current user and/or accountId does not have permission to access this resource."
        }
      },
      "ErrorNotFound": {
        "description": "Not Found",
        "value": {
          "type": "https://developers.avayacloud.com/avaya-infinity/docs/error-handling#resource-not-found",
          "title": "Resource Not Found",
          "status": 404,
          "detail": "Resource not found."
        }
      },
      "ErrorInternalServerError": {
        "description": "Server Error",
        "value": {
          "type": "https://developers.avayacloud.com/avaya-infinity/docs/error-handling#server-error",
          "title": "Server Error",
          "status": 500,
          "detail": "An internal server error was encountered."
        }
      }
    }
  }
}
````