TicketUserServices

CancelRecurringPaymentRequest

The following routes are available for this service:
POST	/recurringPayments/cancel
POST	/recurringPayments/{Id}/cancel

**CancelRecurringPaymentRequest** Parameters:
Name	Parameter	Data Type	Required
Id	path	int	No
PaymentTokenId	body	string	No
Phone	body	string	No
Reason	body	string	No
Via	body	string	No

**CancelRecurringPaymentResult** Parameters:
Name	Parameter	Data Type	Required
Ok	form	bool	No
Id	form	int	No
Effect	form	string	No
Status	form	string	No
SubscriptionLength	form	int	No
PriorSubscriptionLength	form	int	No
MonthsPaid	form	int	No
CancelledAt	form	DateTime?	No
Reason	form	string	No
AlreadyCancelled	form	bool	No
Remaining	form	int?	No
StatusCode	form	int	No
Message	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /recurringPayments/cancel HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelRecurringPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Id>0</Id>
  <PaymentTokenId>String</PaymentTokenId>
  <Phone>String</Phone>
  <Reason>String</Reason>
  <Via>String</Via>
</CancelRecurringPaymentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CancelRecurringPaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AlreadyCancelled>false</AlreadyCancelled>
  <CancelledAt>0001-01-01T00:00:00</CancelledAt>
  <Effect>String</Effect>
  <Id>0</Id>
  <Message>String</Message>
  <MonthsPaid>0</MonthsPaid>
  <Ok>false</Ok>
  <PriorSubscriptionLength>0</PriorSubscriptionLength>
  <Reason>String</Reason>
  <Remaining>0</Remaining>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
  <SubscriptionLength>0</SubscriptionLength>
</CancelRecurringPaymentResult>