TicketUserServices

<back to all web services

CancelRecurringPaymentRequest

Requires Authentication
The following routes are available for this service:
POST/recurringPayments/cancel
POST/recurringPayments/{Id}/cancel
import Foundation
import ServiceStack

public class CancelRecurringPaymentRequest : Codable
{
    public var id:Int?
    public var paymentTokenId:String?
    public var phone:String?
    public var reason:String?
    public var via:String?

    required public init(){}
}

public class CancelRecurringPaymentResult : Codable
{
    public var ok:Bool?
    public var id:Int?
    public var effect:String?
    public var status:String?
    public var subscriptionLength:Int?
    public var priorSubscriptionLength:Int?
    public var monthsPaid:Int?
    public var cancelledAt:Date?
    public var reason:String?
    public var alreadyCancelled:Bool?
    public var remaining:Int?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}


Swift CancelRecurringPaymentRequest DTOs

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>