Jump to

• Request
• Response
• Examples

Delete a subscription

delete

/apiplatform/management/v1/plans/{planId}/subscriptions/{subId}

Deletes, cancels, or dismisses the {subId} subscription from the {planId} plan. The action performed depends on the subscription state: if SUBSCRIBED or SUSPENDED, the subscription is deleted; if REQUESTING, the subscription is cancelled; if REJECTED, the subscription is dismissed.

Users requesting this resource must be assigned the API Manager, Plan Manager, or Application Developer role and must be issued the Subscribe or Manage Subscribed Application grant for the specified plan. Users must also be issued the Manage Application grant for the application to delete a SUBSCRIBED or SUSPENDED subscription, cancel a REQUESTING subscription, or dismiss a REJECTED subscription.

Request

Supported Media Types

• application/json

Path Parameters

• planId: string
  A unique ID referencing a specific plan.
• subId: string
  A unique ID referencing a specific subscription.

Back to Top

Response

Supported Media Types

• application/json

204 Response

The subscription was deleted.

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to delete a subscription to a plan by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X DELETE 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/subscriptions/{subId}

• {planId} is the unique Id for a plan. To retrieve available plan Ids, see Get plans.

• {subId} is the unique Id for a subscription. To retrieve available subscription Ids, see Get subscriptions.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Wed, 15 Mar 2017 06:39:49 GMT
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00021bf2
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top