POST api/{version}/ProductSubscription/CancelStudentSubscription
To cancel the subscription by studentproductid
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
CancelProductSubscriptionInput| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentOrderId |
Gets or sets the student order id |
integer |
None. |
| StudentProductId |
Gets or sets the student product id |
integer |
None. |
| Isfromonline |
Gets or sets whether it is from online |
boolean |
None. |
| CancelSubscription |
Gets or sets the cancel subscription |
boolean |
None. |
| CancellationFee |
Gets or sets the cancellation fee |
decimal number |
None. |
| CancellationComments |
Gets or sets the cancellation comments |
string |
None. |
| isNoNeedToUpdateProductEndDate |
Gets or sets whether product end date needs to be updated |
boolean |
None. |
| CancelledDateTime |
Gets or sets the cancelled date time |
string |
None. |
| isLastItem |
Gets or sets flag whether is last item |
boolean |
None. |
| IsCancelFreeProduct |
Gets or sets the flag to cancel free product |
boolean |
None. |
| UserId |
Gets or sets the user id for storing in the log |
integer |
None. |
| UserType |
Gets or sets the user type for storing in the log |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"StudentOrderId": 1,
"StudentProductId": 2,
"Isfromonline": true,
"CancelSubscription": true,
"CancellationFee": 5.1,
"CancellationComments": "sample string 6",
"isNoNeedToUpdateProductEndDate": true,
"CancelledDateTime": "sample string 8",
"isLastItem": true,
"IsCancelFreeProduct": true,
"UserId": 11,
"UserType": "sample string 12"
}
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
Sample:
true
text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>