TicketUserServices

<back to all web services

CancelRecurringPaymentRequest

Requires Authentication
The following routes are available for this service:
POST/recurringPayments/cancel
POST/recurringPayments/{Id}/cancel
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class CancelRecurringPaymentRequest
            Public Overridable Property Id As Integer
            Public Overridable Property PaymentTokenId As String
            Public Overridable Property Phone As String
            Public Overridable Property Reason As String
            Public Overridable Property Via As String
        End Class

        Public Partial Class CancelRecurringPaymentResult
            Public Overridable Property Ok As Boolean
            Public Overridable Property Id As Integer
            Public Overridable Property Effect As String
            Public Overridable Property Status As String
            Public Overridable Property SubscriptionLength As Integer
            Public Overridable Property PriorSubscriptionLength As Integer
            Public Overridable Property MonthsPaid As Integer
            Public Overridable Property CancelledAt As Nullable(Of Date)
            Public Overridable Property Reason As String
            Public Overridable Property AlreadyCancelled As Boolean
            Public Overridable Property Remaining As Nullable(Of Integer)
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET 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>