POST api/v1/memberships/cancel

Cancel an existing membership. The membership will be terminated on the monthly anniversary of the renewal date.

Request Information

URI Parameters

None.

Body Parameters

MembershipCancelBindingModel
NameDescriptionTypeAdditional information
Authentication

AuthenticationModel

Required

Request

MembershipCancelRequestModel

Required

Request Formats

application/json, text/json

Sample:
{
  "Authentication": {
    "Id": "sample string 1",
    "Key": "sample string 2"
  },
  "Request": {
    "MembershipEmail": "sample string 1",
    "AssociationName": "sample string 2",
    "CancellationReason": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<MembershipCancelBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Authentication>
    <Id>sample string 1</Id>
    <Key>sample string 2</Key>
  </Authentication>
  <Request>
    <AssociationName>sample string 2</AssociationName>
    <CancellationReason>sample string 3</CancellationReason>
    <MembershipEmail>sample string 1</MembershipEmail>
  </Request>
</MembershipCancelBindingModel>

Response Information

Resource Description

MembershipOutgoingModel
NameDescriptionTypeAdditional information
Message

MessageModel

None.

Response

IMembershipResponseModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": {
    "Code": "sample string 1",
    "Description": "sample string 2"
  },
  "Response": null
}

application/xml, text/xml

Sample:
<MembershipOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Message>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </Message>
  <Response i:nil="true" />
</MembershipOutgoingModel>