PUT api/Subscription

Upgrade a subscription to other plan

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompanyID	integer	Required
OldSubscriptionPlanID	integer	Required
NewSubscriptionPlanID	integer	Required

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "companyID": 1,
  "oldSubscriptionPlanID": 2,
  "newSubscriptionPlanID": 3
}

application/xml, text/xml

Sample:

<UpgradeSubscriptionRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <CompanyID>1</CompanyID>
  <NewSubscriptionPlanID>3</NewSubscriptionPlanID>
  <OldSubscriptionPlanID>2</OldSubscriptionPlanID>
</UpgradeSubscriptionRequestModel>

multipart/form-data

Sample:

<UpgradeSubscriptionRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><CompanyID>1</CompanyID><NewSubscriptionPlanID>3</NewSubscriptionPlanID><OldSubscriptionPlanID>2</OldSubscriptionPlanID></UpgradeSubscriptionRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of UpgradeSubscriptionResponseModel

Name	Type	Additional information
CompanyID	integer	None.
OldSubscriptionPlanID	integer	None.
NewSubscriptionPlanID	integer	None.
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

[
  {
    "companyID": 1,
    "oldSubscriptionPlanID": 2,
    "newSubscriptionPlanID": 3,
    "returnID": 4,
    "message": "sample string 5",
    "successful": true,
    "code": 7,
    "totalRecord": 8
  },
  {
    "companyID": 1,
    "oldSubscriptionPlanID": 2,
    "newSubscriptionPlanID": 3,
    "returnID": 4,
    "message": "sample string 5",
    "successful": true,
    "code": 7,
    "totalRecord": 8
  }
]

application/xml, text/xml

Sample:

<ArrayOfUpgradeSubscriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <UpgradeSubscriptionResponseModel>
    <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">7</Code>
    <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 5</Message>
    <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</ReturnID>
    <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
    <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</TotalRecord>
    <CompanyID>1</CompanyID>
    <NewSubscriptionPlanID>3</NewSubscriptionPlanID>
    <OldSubscriptionPlanID>2</OldSubscriptionPlanID>
  </UpgradeSubscriptionResponseModel>
  <UpgradeSubscriptionResponseModel>
    <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">7</Code>
    <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 5</Message>
    <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</ReturnID>
    <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
    <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</TotalRecord>
    <CompanyID>1</CompanyID>
    <NewSubscriptionPlanID>3</NewSubscriptionPlanID>
    <OldSubscriptionPlanID>2</OldSubscriptionPlanID>
  </UpgradeSubscriptionResponseModel>
</ArrayOfUpgradeSubscriptionResponseModel>

multipart/form-data

Sample:

<ArrayOfUpgradeSubscriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><UpgradeSubscriptionResponseModel><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">7</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 5</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</TotalRecord><CompanyID>1</CompanyID><NewSubscriptionPlanID>3</NewSubscriptionPlanID><OldSubscriptionPlanID>2</OldSubscriptionPlanID></UpgradeSubscriptionResponseModel><UpgradeSubscriptionResponseModel><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">7</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 5</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</TotalRecord><CompanyID>1</CompanyID><NewSubscriptionPlanID>3</NewSubscriptionPlanID><OldSubscriptionPlanID>2</OldSubscriptionPlanID></UpgradeSubscriptionResponseModel></ArrayOfUpgradeSubscriptionResponseModel>