PUT rest/v1/subscription/{subscriptionId}/cancel

Request Information

URI Parameters

Name	Description	Type	Additional information
subscriptionId		string	Required

Body Parameters

None.

Response Information

Resource Description

CancelSubscriptionResponse

Name	Type	Additional information
cancelledDate	string	None.
subscriptionId	string	None.
invoiceId	string	None.
paymentId	string	None.
paidAmount	string	None.
totalDeltaMrr	string	None.
totalDeltaTcv	string	None.
success	boolean	None.
processId	string	None.
reasons	Collection of Reason	None.

Response Formats

application/json, text/json

Sample:

{
  "cancelledDate": "sample string 1",
  "subscriptionId": "sample string 2",
  "invoiceId": "sample string 3",
  "paymentId": "sample string 4",
  "paidAmount": "sample string 5",
  "totalDeltaMrr": "sample string 6",
  "totalDeltaTcv": "sample string 7",
  "success": true,
  "processId": "sample string 9",
  "reasons": [
    {
      "code": 1,
      "message": "sample string 2"
    },
    {
      "code": 1,
      "message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<CancelSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Subscriptions.HMH.Common.APIEntities">
  <processId>sample string 9</processId>
  <reasons>
    <Reason>
      <code>1</code>
      <message>sample string 2</message>
    </Reason>
    <Reason>
      <code>1</code>
      <message>sample string 2</message>
    </Reason>
  </reasons>
  <success>true</success>
  <cancelledDate>sample string 1</cancelledDate>
  <invoiceId>sample string 3</invoiceId>
  <paidAmount>sample string 5</paidAmount>
  <paymentId>sample string 4</paymentId>
  <subscriptionId>sample string 2</subscriptionId>
  <totalDeltaMrr>sample string 6</totalDeltaMrr>
  <totalDeltaTcv>sample string 7</totalDeltaTcv>
</CancelSubscriptionResponse>