1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Services

terminateService

post

/ccstore/v1/services/{id}/terminate

Renew a service associated with a user.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
ID of an asset.
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request
Body Parameter
Root Schema : action_request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : action_response
Nested Schema : configuratorItem
Type: object
The configured item
Nested Schema : childItems
Type: array
Nested Schema : externalData
Type: array
Information about the configured item.
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The externalData values.
Example application/json

{
    "configuratorItem":{
        "serviceAccountId":"",
        "deactivationDate":"",
        "amount":"",
        "quantity":0,
        "externalRecurringCharge":"",
        "externalData":[
            {
                "values":{
                    "displayValue":"",
                    "name":"",
                    "label":""
                },
                "name":""
            }
        ],
        "billingAccountId":"",
        "externalRecurringChargeFrequency":"",
        "childItems":[
            "#/configuratorItem"
        ],
        "catalogRefId":"",
        "configuratorId":"",
        "externalRecurringChargeDuration":"",
        "externalPrice":"",
        "customerAccountId":"",
        "assetId":"",
        "actionCode":"",
        "serviceId":"",
        "activationDate":""
    }
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |551000|Could not get customers profile.| |551001|Customer has no service account.| |551002|Error retrieving customers service account.| |551003|Error retrieving account assets.| |551004|Error validating contact account ids in Order. |551005|Invalid account asset id. |551006|Account asset authorization error. |551007|Owner of the account asset could not be determined. |551008|Error submitting action request. |551009|Invalid transactionDate.
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{"configuratorItem": {
  "serviceAccountId": "",
  "deactivationDate": "",
  "amount": "",
  "quantity": 0,
  "externalRecurringCharge": "",
  "externalData": [{
    "values": {
      "displayValue": "",
      "name": "",
      "label": ""
    },
    "name": ""
  }],
  "billingAccountId": "",
  "externalRecurringChargeFrequency": "",
  "childItems": ["#/configuratorItem"],
  "catalogRefId": "",
  "configuratorId": "",
  "externalRecurringChargeDuration": "",
  "externalPrice": "",
  "customerAccountId": "",
  "assetId": "",
  "actionCode": "",
  "serviceId": "",
  "activationDate": ""
}}