1.3. SuspendSubscription

Overview

Suspend Azure Subscriptions

Classification

  • Delete

API Operation Object

  • Azure

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{api_endpoint}/v1.0/{tenant_id}/subscriptions/suspendsubscription

HTTP Request Header

Format

Content-Type: application/json
X-Auth-Token: <token_id>

HTTP Request Body

Format

{
    "suspend_subscription":
    {
        "subscription_id": [
            "<subscription id>",
            "<subscription id>"
        ]
    }
}

Request Parameter

Request Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
tenant_id URL String(UUID) The unique identifier of the tenant. required - Terminate 404
token_id Header String(token_id) - required - Terminate 403
subscription_id Body String(UUID) (Array) Suspend target subscriptions required - Terminate 404

Response

HTTP Response Header

Format

HTTP/1.1 <response code> <message> (ex. 202 Accepted)
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
202 Accepted
400 Bad Request
403 Unauthorized(including keystone down)
404 Not Found

HTTP Response Body

Format

None

Response Parameter

None