terminateService
post
/ccstore/v1/services/{id}/terminate
Renew a service associated with a user.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
ID of an asset.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request
Root Schema : action_request
Type:
Show Source
object
-
transactionDate:
string
The date and time on which the service request was made.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : action_response
Type:
Show Source
object
-
configuratorItem:
object configuratorItem
The configured item
Nested Schema : configuratorItem
Type:
object
The configured item
Show Source
-
actionCode:
string
The configuration session identifier.
-
activationDate:
string
Date on which the service contract starts.
-
amount:
string
The total amount of this item and sub items.
-
assetId:
string
The id of the account asset.
-
billingAccountId:
string
The id of the billing account.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The item sku id.
-
childItems:
array childItems
-
configuratorId:
string
The configuration session identifier.
-
customerAccountId:
string
The id of the customer account.
-
deactivationDate:
string
Date on which the service contract ends.
-
externalData:
array externalData
Information about the configured item.
-
externalPrice:
string
The price of this item.
-
externalRecurringCharge:
string
The items recurring charge.
-
externalRecurringChargeFrequency:
string
The frequency of the recurring charges, E.g Per Month.
-
externalRecurringDuration:
string
The duration of the recurring charges, E.g 1 Year.
-
quantity:
integer
The items quantity.
-
serviceAccountId:
string
The id of the service account.
-
serviceId:
string
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : items
Type:
Show Source
object
-
name:
string
Name of the externalData item.
-
values:
object values
The externalData values.
Nested Schema : values
Type:
object
The externalData values.
Show Source
-
displayValue:
string
externalData vaulue value.
-
label:
string
externalData vaulue label.
-
name:
string
externalData vaulue description.
Example Response (application/json)
{
"configuratorItem":{
"serviceAccountId":"",
"deactivationDate":"",
"amount":"",
"quantity":0,
"externalRecurringCharge":"",
"billingProfileId":"billingProfile-123",
"externalData":[
{
"values":{
"displayValue":"",
"name":"",
"label":""
},
"name":""
}
],
"billingAccountId":"",
"externalRecurringChargeFrequency":"",
"childItems":[
"#/configuratorItem"
],
"transactionDate":"2018-06-27T12:59:59Z",
"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.
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code