POST memberships/cancelAndStartNew
Authorized only.
Request Information
URI Parameters
None.
Body Parameters
CancelAndStartNewMembershipRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CancellingMembershipId | integer |
None. |
|
| CancellationDate | date |
None. |
|
| CancellationReason | string |
None. |
|
| BalanceTransferAction | MembershipBalanceTransferAction |
None. |
|
| NewMembershipInfo | MembershipInfoMobile |
None. |
Request Formats
application/json, text/json
Sample:
{
"CancellingMembershipId": 1,
"CancellationDate": "2026-05-04T05:12:02.3788949-04:00",
"CancellationReason": "sample string 2",
"BalanceTransferAction": 0,
"NewMembershipInfo": {
"CustomerId": 1,
"CompanyId": 2,
"EmployeeId": 3,
"OrderId": 1,
"OrderItemId": 1,
"IsMembership": true,
"ProductId": 5,
"ProductTypeId": 6,
"CreditCardTokenId": 1,
"Name": "sample string 7",
"Type": "sample string 8",
"FrequencyTypeId": 9,
"FrequencyType": "sample string 10",
"CustomFrequency": 1,
"Price": 11.0,
"MembershipId": "sample string 12",
"IsActive": true,
"IsFinished": true,
"IsCancelled": true,
"IsFullPaid": true,
"Status": "sample string 17",
"Term": 18,
"TermFull": "sample string 19",
"StopReason": "sample string 20",
"AutoRenew": true,
"Balance": 22.0,
"ServiceDiscountCode": "sample string 23",
"ProductDiscountCode": "sample string 24",
"StartDate": "2026-05-04T05:12:02.3788949-04:00",
"NextChargeDate": "2026-05-04T05:12:02.3788949-04:00",
"FinishDate": "2026-05-04T05:12:02.3788949-04:00",
"InternalMobileId": 27,
"Id": 1,
"MobileId": 1,
"IsInserted": true,
"IsUpdated": true,
"IsDeleted": true
}
}
application/xml, text/xml
Sample:
<CancelAndStartNewMembershipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Data.Mapping.Mobile.Catalog">
<BalanceTransferAction>Keep</BalanceTransferAction>
<CancellationDate>2026-05-04T05:12:02.3788949-04:00</CancellationDate>
<CancellationReason>sample string 2</CancellationReason>
<CancellingMembershipId>1</CancellingMembershipId>
<NewMembershipInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Catalog">
<Id xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">1</Id>
<InternalMobileId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">27</InternalMobileId>
<IsDeleted xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">true</IsDeleted>
<IsInserted xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">true</IsInserted>
<IsUpdated xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">true</IsUpdated>
<MobileId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">1</MobileId>
<d2p1:AutoRenew>true</d2p1:AutoRenew>
<d2p1:Balance>22</d2p1:Balance>
<d2p1:CompanyId>2</d2p1:CompanyId>
<d2p1:CreditCardTokenId>1</d2p1:CreditCardTokenId>
<d2p1:CustomFrequency>1</d2p1:CustomFrequency>
<d2p1:CustomerId>1</d2p1:CustomerId>
<d2p1:EmployeeId>3</d2p1:EmployeeId>
<d2p1:FinishDate>2026-05-04T05:12:02.3788949-04:00</d2p1:FinishDate>
<d2p1:FrequencyType>sample string 10</d2p1:FrequencyType>
<d2p1:FrequencyTypeId>9</d2p1:FrequencyTypeId>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsCancelled>true</d2p1:IsCancelled>
<d2p1:IsFinished>true</d2p1:IsFinished>
<d2p1:IsFullPaid>true</d2p1:IsFullPaid>
<d2p1:IsMembership>true</d2p1:IsMembership>
<d2p1:MembershipId>sample string 12</d2p1:MembershipId>
<d2p1:Name>sample string 7</d2p1:Name>
<d2p1:NextChargeDate>2026-05-04T05:12:02.3788949-04:00</d2p1:NextChargeDate>
<d2p1:OrderId>1</d2p1:OrderId>
<d2p1:OrderItemId>1</d2p1:OrderItemId>
<d2p1:Price>11</d2p1:Price>
<d2p1:ProductDiscountCode>sample string 24</d2p1:ProductDiscountCode>
<d2p1:ProductId>5</d2p1:ProductId>
<d2p1:ProductTypeId>6</d2p1:ProductTypeId>
<d2p1:ServiceDiscountCode>sample string 23</d2p1:ServiceDiscountCode>
<d2p1:StartDate>2026-05-04T05:12:02.3788949-04:00</d2p1:StartDate>
<d2p1:Status>sample string 17</d2p1:Status>
<d2p1:StopReason>sample string 20</d2p1:StopReason>
<d2p1:Term>18</d2p1:Term>
<d2p1:TermFull>sample string 19</d2p1:TermFull>
<d2p1:Type>sample string 8</d2p1:Type>
</NewMembershipInfo>
</CancelAndStartNewMembershipRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |