Renew Subscription

Renews an existing subscription before or after it has expired. Use this endpoint to keep a subscription ACTIVE indefinitely, or to reactivate an INACTIVE subscription. Optionally update the webhook authToken at the same time.

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 to renew and optionally provide a new authToken

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 and include it in the Authorization: Bearer <token> header of each request.

POST https://core.avaya1234.ec.avayacloud.com/auth/realms/avaya/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=<your_client_id>&client_secret=<your_client_secret>&scope=EVENT_NOTIFICATION

Working with Subscription Renewal

The expiresIn field in every subscription response shows the seconds remaining before expiry. Call this endpoint before expiresIn reaches zero to avoid the subscription becoming INACTIVE.

If a subscription has already become INACTIVE, this endpoint can still be used to reactivate it — event delivery will resume immediately upon successful renewal.

To rotate your webhook verification token at the same time as renewing, include the new authToken value in the request body.

Important Notes

• The request body is optional. If omitted, the subscription is renewed without changing any transport configuration.
• Returns a 404 if no subscription exists with the specified ID.

DOS Protection & Rate Limiting

• This endpoint implements DOS protection and rate limiting.

Security Implementation Guidelines

• Never expose your client_secret or Bearer token to client-side applications.
• Rotate your webhook authToken regularly to maintain security.
• Implement proper error handling — avoid surfacing internal error details to end users.