Cancel a subscription
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/cancel
Request
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/vnd.oracle.adf.action+json
Response
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
Examples
The following example shows how to cancel a subscription by submitting a post request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/CDRM_15008/action/cancel
Example of Request Body using SubscriptionProductPuid
The following shows the contents of the request body in JSON format.
{ "cancelReason":"ORA_PRICING", "canceledDate":"2019-06-03" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "result": "300" }
Example of Request Body using ExternalAssetKey
The following shows the contents of the request body in JSON format.
{ "name":"calculateEarlyTerminationFee", "parameters":[ {"externalAssetKey": "Asset-001"}, {"closedDate": "2020-09-29"} ] }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "result": "300" }
Note:
If you pass both Subscription Product PUID and External Asset Key, Product PUID will be considered.