PUT rest/v1/subscription/{subscriptionNumber}/change

Request Information

URI Parameters

Name	Description	Type	Additional information
subscriptionNumber		string	Required

Body Parameters

ChangeSubscriptionRequest

Name	Description	Type	Additional information
ProductRatePlanId		string	None.
CouponCode		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProductRatePlanId": "sample string 1",
  "CouponCode": "sample string 2"
}

application/xml, text/xml

Sample:

<ChangeSubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Subscriptions.HMH.Common.APIEntities">
  <CouponCode>sample string 2</CouponCode>
  <ProductRatePlanId>sample string 1</ProductRatePlanId>
</ChangeSubscriptionRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ChangeSubscriptionRequest'.

Response Information

Resource Description

ChangeSubscriptionResponse

Name	Type	Additional information
subscriptionId	string	None.
totalDeltaMrr	decimal number	None.
totalDeltaTcv	Object	None.
Success	boolean	None.
ProcessId	string	None.
Reasons	Collection of Reason	None.

Response Formats

application/json, text/json

Sample:

{
  "subscriptionId": "sample string 1",
  "totalDeltaMrr": 2.1,
  "totalDeltaTcv": {},
  "success": true,
  "processId": "sample string 5",
  "reasons": [
    {
      "code": 1,
      "message": "sample string 2"
    },
    {
      "code": 1,
      "message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ChangeSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Subscriptions.HMH.Common.APIEntities">
  <processId>sample string 5</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>
  <SubscriptionId>sample string 1</SubscriptionId>
  <TotalDeltaMrr>2.1</TotalDeltaMrr>
  <TotalDeltaTcv />
</ChangeSubscriptionResponse>