Delete a subscription
/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
- application/json
-
planId: string
A unique ID referencing a specific plan.
-
subId: string
A unique ID referencing a specific subscription.
Response
- application/json
204 Response
403 Response
object
-
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
500 Response
object
-
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
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